From 8fee11f5dd30e228a850ee25a2f3368dc1671b53 Mon Sep 17 00:00:00 2001 From: ramparab <49212302+ramparab@users.noreply.github.com> Date: Thu, 10 Sep 2020 09:50:43 -0700 Subject: [PATCH] FR v2.1-preview.1 update (#10747) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Bringing FRv2.0-preview version forward. * Adding Model Compose feature * Adding Model Copy feature * Adding PreBuilt: Business card feature * Fix swagger version. * Add CheckBox feature (option-A) * Add CheckBox feature (option-B) * Initial commit; Bringing things forward from v2.0 * Minor fixes in compose contract * Add suggested model name changes for supervised * Incorporating final changes from v2.0-preview * Incorporating ModelName feature * Update for model compose * Incorporating selectionMark feature. * FRv2.1 Feature updates (#13) List of changes: ----------------- * Bringing Final swagger for FRv2.0-preview version forward. * Adding Model Compose feature * Adding PreBuilt: Business card feature * Add SelectionMark (aka CheckBox) feature * ModelName Support * Fix swagger version * FR FE changes (#15) * Remove quotes from data queries in RI apis (#9323) * [DataFactory]Store settings should be added for Delete and GetMetadata (#9208) * [DataFactory]Store settings should be added for Delete and GetMetadata Activity * Add format settings for GetMetadata * [Hub Generated] Review request for Microsoft.ChangeAnalysis to add version preview/2020-04-01-preview (#8981) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * add swagger spec second time * trying to fix violations #1 * adding descriptions and schema tag for default error * removing required location element from proxy resource. * adding prettifier fixed * update 3 * update 4 * update 5 * update 6 * update 7 * update 8 * update 9 * update 10 * update 11 * update 12 * update 13 * update 14 * update 15 * update 16 * update 17 * update 18 * Adds suppression to readme * updating comments of few models * changing description of few elements * prettier run: Co-authored-by: Alex Dubinkov * regenerated all-api-versions * Fix readme.go.md for some sql service (#9348) * Update network (#9349) * Add multiapi section (#9347) * Dataplane swagger for tables (#8151) * adding swagger for tables dataplane * updating produces/consumes, adding format parameter and adding DataServiceVersion header * update swagger so that query parameters do not appear in x-ms-paths * add new custom words, fix incorrect api version * making suggested changes to continuation header, response status codes * Updates to tables spec * Fixed indentation * Removed storage references * Grammar * Improved match condition description * Remove format statements * Removed excess tags * Fix extra commas * Added missing example * Updated Delete example * Run prettier * Removed duplicate API version * Fixed insert response * Removed 2018 readme tag * Remove storage name * Remove multi-api reference Co-authored-by: Sam Hurd Co-authored-by: annatisch * regenerated all-api-versions * Datr m (#9332) * update readme docs * add nullables * add autogen * location required * add require to all * add requires * prettier * track resoruce ref and require for properties * remove # * fix # resoruce * pr comments * fix ruby * go fix * azure_mgmt_desktop_virtualization * rekickoff tests * regenerated all-api-versions * Allow empty access policies array in HealthcareApis (#9326) * Allow empty access polies array in HealthcareApis. * accessPolicies property can be omitted * [CDN] Add API version 2020-04-15 (#9242) * regenerated all-api-versions * Update readme.md (#9384) * Update readme.md Adding stable version to not break existing APIs * Added examples * fix example * prettier fix * regenerated all-api-versions * [MixedReality] Version Iteration for new Releases (#9351) * Version Iteration for new Releases (#8848) * Version Iteration for new Releases There are going to be 2 significant releases: 1. Public Preview of Remote Rendering in April 6th 2. GA of Spatial Anchors in May * Referring new swagger files in readme.md * Specifying default package version as 2020-05-01 * Fix MV * Fix MV (#9397) Fix MV in Patch examples Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni * fix network (#9369) * fix network * duplicated publicipprefix * fixed example in 2018-01-01 * final updates * missing examples * regenerated all-api-versions * SQLDB - update LicenseType description (#9001) * SDK support for Table and Queue Storage Services (#9259) * Adding table spec, without examples * Adding queue swagger, also updating comments for table * Updated the models to include ARM fields, completed, no examples * Added list table and queue services spec * Adding table CRUD examples * Adding Queue CRUD examples * Validation complete, TablName changed to camelCase * Modified comment * Spell correction * changing order in readme.md * Changed the object name from Queue to StorageQueue, as sdk code gen throws name conflict error with Collections.Queue * Resolve prettier check errors * Change URI param to be camel case * updated default error response schema * Change Default error response model schema * Added x-ms-nextLink * regenerated all-api-versions * [ACR] add regionEndpointEnabled to replication properties and replicationUpdateParameters (#8840) * add regionendpointenabled to replication properties and replicationupdateparameters * fix property placement error * Update spec. with update properties * Update descriptions Co-authored-by: Tosin Adewale * update triage label (#9396) * validate blockchain cli codegen (#9089) * validate blockchain cli codegen * use strong password with length>=12 Co-authored-by: Changlong Liu * feat: add subscription 2019 10 01 preview (#9388) * [Hub Generated] Review request for Microsoft.CostManagement to add version stable/2019-11-01 (#9288) * adding the views api to the 2019-11-01 version * Fix api version value * adding private view list example document * Fix enum conflict * fix Granularity enum type * Add api version of go SDK for imagebuilder (#9408) * Update PR template (#9371) * Update PR template * Add FAQ link * add Microsoft.AVS 2019-08-09-preview API spec (#9307) * cp -r vmwarevirtustream vmware * rebrand * add sku to PrivateCloud * add SSL thumbprints * Fix description typo (#5) * lists return value[] * suppress R3020 * fix suppress * add Locations_ prefix Co-authored-by: jspearman3 * regenerated all-api-versions * Add 2020-04-01 API specification for Microsoft.Peering (#9361) * Remove readonly flag from microsoftSessionAddress properties in BgpSession; add an example for IxRs directPeeringType * Add 2020-04-01 API specification for Microsoft.Peering * Fix subId * Fix static validation issues * Fix GetPeeringReceivedRoutes example * Fix PeeringServiceSku * Add RPKI to custom-words * Update readme to include package-2020-04-01 * Fix input file path in package-2020-04-01 * Fix ErrorResponse data model Co-authored-by: Praneeth Sanapathi * Move added client name IdentityUserAssignedIdentitiesValue into an inner scope (#9363) * Bug fixes: skip url encoding for ScopeParameter; add client name for userAssignedIdentities. * Pretty check fix. * Move added client name into additionalProperties of userAssignedIdentities. * Change operationID for table and queue, update the name of an example (#9410) * update version of rest-api-specs-scripts in PPE (#9420) Co-authored-by: Jianye Xi * adding new properties (#9404) * Pipeline devops (#9374) * netapp trenton pipeline * logic pipeline test * Revert "logic pipeline test" This reverts commit ad9f1f00d99379de1e461fcbb6c803a491b5bd29. * devops pipeline test * Update readme.md Co-authored-by: root * typo (#9210) * IoT Edge in Central APIs initial (#9248) * IoT Edge in Central APIs initial * making recommended fixes * Moved storage private link related models into common types (#8935) * Moved private link related model into common types * Fix path to common types.json * Fix parameter reference * fix prettier issue * Resovled the conflict and moved PrivateEndpointConnectionListResult into common and updated reference * EventGrid: Update 2020-04-01-preview swagger to include new properties per customer's feedback (#9402) * Update 2020-04-01-preview swagger to include new properties per customer's feedback * fix spelling * add readonly flag for readiness state * fix prettier Co-authored-by: Ashraf Hamad * [Hub Generated] Review request for Microsoft.VirtualMachineImages to add version stable/2020-02-14 (#9411) * [Azure Stack] Updates to Azs.Storage.Admin spec (#8959) * commit 1ef81911c39d8f618bf6ec097223ff5e8961b3cb Author: Yuxing Zhou Date: Thu Feb 6 09:13:52 2020 +0800 [Azure Stack] Update storage admin specs for new generation with autorest-beta (#8306) * Update storage admin specs for new generation with autorest-beta * fix code style commit 9e551f0eab4057d4c2f54c333c7aa2a1a564c125 Author: bganapa Date: Tue Nov 12 11:44:22 2019 -0800 Reset to Stackadmin2 (#7766) * Fix resourcegroup case * Fix old version * Address PR feedback * Customerprovider pipeline2[DONOT MERGE] (#9428) * customer provider * add flag * Add DeletedWorkspaces API (#9401) * Add force flag (#9417) * Add force flag * Fix * [Storage] Adding support for listing soft deleted blob containers (#9435) * [Storage] Adding support for listing soft deleted blob containers . Adding swagger support for listing soft deleted blob containers . Added examples as well * Update blob.json * Update DeletedBlobContainersList.json Prettier check failing * Create a New Default Tag for Code Generation (#9440) Include both Spatial Anchors and Remote Rendering in the same package. * regenerated all-api-versions * fastfix_tfpr (#9439) Co-authored-by: Xiaoxu Qi * Adding 200 response in CreateOrUpdate api (#9228) * Adding 200 response in CreateOrUpdate api * Update example * Empty commit to trigger build * Updated README tag version (#9240) * Updated README tag version * Moved provisioning state under properties, added operations API * fixed json syntax * Added operations list * Added Display * Update bookmark relations API (#8495) * Update bookmark relations API * fix pr comments * fix invalid examples failing model validation * Fixed invalid reference (#9449) * [Hub Generated] Review request for Microsoft.VirtualMachineImages to add version stable/2020-02-14 (#9451) * SKU api filter takes location only. (#9328) * change to test logic for az (#9443) * [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9453) * Adding ReservationRecommendationDetails API Adding ReservationRecommendationDetails API * fixing semantic errors * test fix * test * updating property lookbackUnitType * prettified * prettified examples * Updating scope parameter * updating sample * adding 204 status code * updating examples with 204 * updating samples * updating 204 * prettify * prettifying * Update swagger specs for Managed Instance (#8182) - Add optional parameter maintenance configuration id. * luis authoring api updates for nested children and required features (#9405) * luis authoring api updates for nested children and required features * fix examples * change required field "enableNestedChildren" to optional * add default value for enableNestedChildren * remove deprecated permissions API * [Hub Generated] Review request for Microsoft.ResourceGraph to add version stable/2019-04-01 (#9215) * Fixing comments * update oprationId * update oprationId * Revert operation change * test commit * Revert "test commit" This reverts commit 1fb003317a14420f912bf8a625570224d332b227. * cost-management-for-cli-extensions (#9392) * add 2019-10-preview tag for luis (#9406) * upgrade pipeline scripts version to 0.8.0 (#9457) Co-authored-by: Jianye Xi * Make CDN privateEndpointStatus modeled as string (#9433) * [Cognitive Service Computer Vision] Create CV v3.0 API version swagger (#8734) * [Cognitive Service Computer Vision] Create CV v3.0 API version swagger * Complete Compter vision's readme file to fix build issue * Correct CV v3.0 examples to match swagger schema * Run Prettier script on new examples Co-authored-by: bob * regenerated all-api-versions * added app service schema (#9310) * added app service schema * added ref to new file in readme.md * prettier * JSON Lint * created classes for app event type detail * remove delete and create event data * fix format * ran prettier * fix async status and remove description from each ref * remove x-ms-enum for some * fix x-ms-enum * remove x-ms-enum from status * add x-ms-enum to all enum and add model as extensible * typo to model as string * move model as string under x-ms-enum * remove last empty line: * add back last empty line Co-authored-by: Elle Tojaroon * Added new SecureScore API to Microsoft.Security (#8235) * Set theme jekyll-theme-midnight * Adding new APIs for secure score * Updated files * updated md file * Working on 1 path at a time * Fix type to ref * more fixes * removed ref type * AutoRest fixes * more fixes * Internal PR * fixed some static validation issues * Fixed some more auto-rest issues * Fixed example + organizing readonly attribute * Run prettier on files * Changed initiativeId to policySetDefinitionId in the sample files * Changed assessmentsMetadata to assessmentsDefinition * Added scope in defintions example and adjust enum value of BuiltIn * Added missing fields and align examples * Renamed fields in example files * Changed return value * Added control definitions per subscription scope * Added definition property (optional, in case of $expand) * prettier updated files * prettier again ... * PR comments * Renamed enum * Fixed some errors * Remove "secureScoreName" parameter from example * Changed operationId from GetSecureScores_Single to SecureScores_Get * prettifying the code * Updated based on PR comments * Fix casing issues in example files name * Fixing sample files and remove some enum options * Updated readme.md file * Remove trailing whitespace * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json Co-Authored-By: Chen Lahav * Fixed PR comments * Fix definitions renaming * Fix examples * Trying to fix model validation * Changed example type * Updating from master (Resolving conflicts) * Converting all EOL to CRLF + remove trailing blanks * Removed Scope paths, updated examples * Replaced scope with sub id in example * updated secureScoresControls id in examples * example files ids and type fixes Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav * Fix operation Ids for Metadata, so they show up correctly in the REST… (#9414) * Fix operation Ids for Metadata, so they show up correctly in the REST docs toc. * Fix operation id for AvailableServiceTiers * Separate Python readme (#9416) * Updated default tag to latest stable version. (#9085) * Updated default tag to newest stable version. * Modified swagger to include next link property and azure resource properties. * Addressed CI errors. Co-authored-by: Jacob Hill * add time trigger for PR author (#9468) * add time trigger for PR author * add reviewed-changesRequired * api-version 2020-05 of mixedreality for go SDK (#9474) * api-version 2020-05 * fix * [Datafactory] Enable Type Conversion in Copy Activity (#9471) Co-authored-by: David Zhao * kubernetes - fixed client name (#9421) * fixed client name * updated name * Create swagger for a new API: AutoDismissAlertsRules (#7292) * Create swagger for a new API: AutoDismissAlertsRules * Add AutoDismiss rule name parameter to alerts API. Fix some descriptions. * Remove CompromisedEntity from the examples * update readmeFile * Renaming auto dismiss to suppression * Update PutAlertsSuppressionRule_example.json * Fixing example - sending read-only property error * Removing read-only fields from examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json * ARM CR: changing `UTC` to `Utc` + updating expirationDateUtc description * Adding "ScopeElement" for "allOf" element + fixing examples Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha * regenerated all-api-versions * update scripts version in PPE pipeline (#9494) Co-authored-by: Jianye Xi * pricing tier swagger (#9094) * pricing tier swagger * remove readonly in sku model * update appplatform json and example * update list sku * revert to data action * update list skus * add resource sku definition * revert sqlparallel read settings (#9497) * add sharepointonlinelist connector * support parallel read of sql sources * revert sqlparallel settings * [CosmosDB] Introducing the apiVersion 04-01-2020 (#9302) * Adding notebooks in 1212 and 0301 * Changes to include EnableFreeTier property in DatabaseAccount * Ran Prettier * Fixed model failures * Revert "Fixed model failures" This reverts commit ecef06e8b9c7b0ad3c36f5fce84bd72ebee1a141. * Revert "Ran Prettier" This reverts commit 9d2cc52313bf9f45b172f6769d57d3be60ea1d6d. * Revert "Changes to include EnableFreeTier property in DatabaseAccount" This reverts commit 62f58ab6c666d8aad4bbecb94f41e3a80c49289a. * Created apiVersion 2020-05-04 with EnableFreeTier property in DatabaseAccount * Replace IpRangeFilter by IpRules * Revert "Replace IpRangeFilter by IpRules" This reverts commit ddb21350fd4cd927fb4333617f19e85cfc46b5f9. * Fixed EnableFreeTier changes * Replace IpRangeFilter by IpRules * Fixes in model * Revert "Fixes in model" This reverts commit 97a6a0b62c6752cb6f75529e068e9c2c70618c06. * correcting examples * fix in ListByResourcegroup * renaming * changing ipAddressOrRange * fix * fix for model * fix for model * fixing * Adding apiProperties * adding swagger-to-sdk for python * introduces AutoscaleSettings * removing .net from swagger-to-sdk to avoid failing CI * added analyticalStorage related changes * changes in models * addressed comments * correcting IpAdressOrRange * nit * Making OptionsResource object readonly * temporarily disabling js in swagger to sdk * Revert "temporarily disabling js in swagger to sdk" This reverts commit 5d68004a50e0d5e2c41ac19ccc1243893053261a. Co-authored-by: Meha Kaushik * regenerated all-api-versions * add optional properties for saved search (#9498) * add optional properties * Update SavedSearches.json * Update SavedSearches.json * Support Infrastructure Encryption - secondary layer of encryption at … (#8773) * Support Infrastructure Encryption - secondary layer of encryption at REST for accounts. Add a boolean property to Microsoft.Storage/storageAccounts resource under encryption attributes to opt-in for a secondary layer of encryption for data at rest. * requireInfrastructureEncryption is optional and defaults to null. * PPE enable avocado0.6.4 (#9493) * add x-ms-api-version for operations that api-version is required as parameter for sdk (#9441) * Merge Mixed Reality Changes to Master (#9502) * Version Iteration for new Releases (#8848) * Version Iteration for new Releases There are going to be 2 significant releases: 1. Public Preview of Remote Rendering in April 6th 2. GA of Spatial Anchors in May * Referring new swagger files in readme.md * Specifying default package version as 2020-05-01 * Fix MV * Fix MV (#9397) Fix MV in Patch examples * Add MSI property to Remote Rendering Account (#9476) * Add MSI property to Remote Rendering Account * Fix typo * Fix examples * Fix case mismatch in examples Co-authored-by: Lei Ni * regenerated all-api-versions * add issue_assignment and rename assignment.yml (#9510) * add issue_assignment and rename assignment.yml => pull_request_assignment.yml * reserve assignment.yml for a period time * [Hub Generated] Review request for Microsoft.ResourceGraph to add version preview/2020-04-01-preview (#9025) * Adds base for updating Microsoft.ResourceGraph from version stable/2019-04-01 to version 2020-04-01-preview * Updates readme * Updates API version in new specs and examples * Push changes * Validation fixes * More validation fixes * Add x-ms-enum * Adds suppression to readme * Prettier fixes * Fix object type * update operation ids * Adding GraphQuery * Fix added paren * Fix addition of 2020 version * Prettier * Move up properties * Insert to properties bag * Add to resource properly * Move to GraphQueryResource * regenerated all-api-versions * Add subscription bound for cost management (#9514) * Dev todo microsoft.sample rp 2020 05 01 (#9513) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * add new swagger.json * regenerated all-api-versions * add usePrivateLinkConnection parameter to data sync APIs (#9454) * add private link connection parameter to data sync * add usePrivateLinkConnection parameter to examples * allow usePrivateLinkConnection to be read * add usePrivateLinkConnection property to example returns * remove old unreferenced example files * correct swagger version * add syncMemberAzureDatabaseResourceId parameters to examples * fix readme.md * prettify examples * regenerated all-api-versions * Eyes on setting (#9355) * try * commit * commot * try * validation * [Ready For Review] Add APIs for preparing Azure Notebook from AML workspace, and return required info to user for notebook initialization (#9058) * Add Identity to createWorkpace example * swagger change for provisioning Notebook * new line at the end of the file * fixup * address comments * change listresourcepreparationerrors from post to get * address comments * fix ResourceId values in example and fix casing issue * fix casing * remove listResourcePreparationErrors API and add the errors in GetWorkspace * remove an extra coma * remove prepareResourceErrors API * fix errors reported by pipeline * fix prettier check * fix computes examples * one more fix for existing examples * remove identity * address comments * add description to NotebookResourceInfo.resourceId * fix spell check and prettier check * Cli codegen onboard operationsmanagement (#8874) * Cli onboard blockchain (#9530) * Cli onboard hardwaresecuritymodules (#9532) * Policy compliance data enable pagination (#7909) * initial commit * Events for 2019-09-01 * fix oav errors * Update 2019-10 tag with 2019-10-01-policyevents * add file to input list * add policyevents to 2018-07-01-preview version * fix path in readme * add examples in events, add parameters * specfication files * fix avocado * fix typo * Fix prettier * Update description for apiversion param * fix typo and description * Revert Lint warning * Remove metadata from events and add missing compliancestates in examples * Add the missing x-ms-pageable Co-authored-by: Namrata Jagasia Co-authored-by: Phoenix He * regenerated all-api-versions * Logic pipeline (#9372) * netapp trenton pipeline * logic pipeline test Co-authored-by: root * updated the tags for fix doc generation issue. (#9528) Co-authored-by: v-ajnava * [T2] removed duplicated schemas in storage (#9527) * duplicated schemas in storage * trying to fix storage duplication * [Hub Generated] Review request for Microsoft.AlertsManagement to add version preview/2019-05-05-preview (#9540) * Added missing Alert Modification Events * Added Subscription value to Scope Type Enum * EventGrid: Update 2020-04-01-preview swagger to use enum as string for parentType (#9545) * update swagger * fix prettier Co-authored-by: Ashraf Hamad * update @azure/oad version to fix breaking issue (#9551) Co-authored-by: Jianye Xi * [Synapse Data Plane]Add vnet feature to data plane (#8753) * Add vnet feature to data plane * Support multiple client * 1. Add x-ms-pageable to list api Co-authored-by: Zhenyu Zhou * Microsoft.Batch 2020-05-01 (#9452) * Adds base for updating Microsoft.Batch from version stable/2020-03-01 to version 2020-05-01 * Updates readme * Updates API version in new specs and examples * Updates for Microsoft.Batch 2020-05-01 This version adds System Managed Identity to Batch accounts and allows for setting Encryption properties on a Batch account. * Fix swagger errors with private endpoint APIs * updating peering az specification (#9489) * regenerated all-api-versions * test for deviceprovisioningservices (#9350) * Update readme.cli.md * test for deviceprovisioningservices * [Computer Vision 3.0] Update Read Language parameter description to include new languages (#9548) * [AMS] update AMS stable version to include Edge list api (#9492) * [AMS] update AMS stable version to include Edge list api * fix an example * fix better descriptions. * more descriptive description * Add New ApiVersion 2020-03-01 (#9480) * Update SavedSearches.json (#9550) * Link workspace (#8994) * create 2020-04-01-preview version * add LinkedWorkspace * remove tailing whitespace * fix build error * address comments * fix updateAmlCompute example * fix build * address comments Co-authored-by: Richard Li * Add capabilities for cognitive services. (#9491) * Added operations api in Microsoft.OffAzure GA version (#9465) * Create swagger.json Added swagger for vmwaresite, hypervsite, serversite * Update swagger.json Addition of Importsite resource * Referred swagger in readme.md * changed readme to have 2 api-versions * Updated readme * Updated ip address name * Create migrate.json * deleted preview changes * Fixed new version * fixed job definition, get and put site * Update migrate.json * Update migrate.json * Added examples. Removed server and import stacks * Removed extra code * Made it in accordance with private preview PR * Examples added * fixed comments * added tags * Resolved conflicts * fixed file * Fixed spellings * fixed spellings * added examples * fixed example * fixed examples * fixed examples * fixed discrption * fixed prettier check * fixed enums * prettier check * Update readme.md * Added operations list * Create migrate.json * added OperationDisplay definition * error fixed * Update migrate.json * fixed errors * Update Operations_List.json * Update migrate.json * Removed parameters * Ran Prettier check * Update migrate.json * Update migrate.json * prettier check * Added api-version parameter under convertToSinglePlacementGroup for VMSS (#9555) * Update isFollowed property to boolean (#9500) * feat: update java readme (#9570) * Update secureScore.json (#9517) * Update secureScore.json Revert enum custom value and fix SDK creation * Trying to prevent "Breaking changes" when removed * [Hub Generated] Review request for Microsoft.DigitalTwins to add version preview/2020-03-01-preview (#9459) * swagger change * remove integration examples * Enable excel in public swagger (#8875) * Enable excel in public swagger * update * rollback dataflow change Co-authored-by: zhanyu2014 * Remove sample todo resource provider (#9572) * Operationalinsights tables, wokspace capping and sku (#9505) * Workspace tables * Pretty * Fixes * Fix * Fixes * Add missing properties for capping and SKU * Fixes * Fix * PR fixes - change PUT to PATCH * Unrequire properties in /tabels PATCH * Adding the documentations for 5 new lint rules (#9569) * Adding 5 new lint rules * update * update created date * fix typo Co-authored-by: Jianye Xi * Optional 'workspace' property (#9495) Co-authored-by: Liran Chen * enable trenton package in prod (#9582) Co-authored-by: Xiaoxu Qi * [Hub Generated] Review request for Microsoft.ManagedServices to add version preview/2020-02-01-preview (#8913) * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Added all changes from PR 1138 to a new API version folder * Removed readOnly: true from multiFactorAuthProvider * Added principalIdDisplayName and delegatedRoleDefinitionsId to Authorization object + changed description of maximumActivationDuration to reflect ISO 8601 format * Made changes reflecting Chris Eggert's suggestions * Fixed camel case mistake * Fixed registrationDefinitionIdParameter references * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Updated read.md * Fixed wrong tag in readme * regenerated all-api-versions * Add reboot parameters. (#9426) * Add reboot parameters. * Add examples and remove required on rebootType. * Fix prettier errors. * Azure Spring Cloud: Support API to enable/disable MSI (#8966) * Azure Spring Cloud: Support API to enable/disable MSI * Fix issue Co-authored-by: Xiaoyun Ding * [Azure SignalR service]Support Private Link and add new api-version (#9377) * Run prettier * Adding new apiVersion 2020-05-01 and support PrivateLink * Using the same schema for SignalR PUT api * No changes, to trigger pipeline build * Using shared definition to avoid duplication * resolve comments * fix avocado * Removing legacy file * add readme file for alertsmanagement (#9578) * update package name and output folder in readme.typescript.md * add trenton readme file for alertsmanagement * update override for type * Get buildID for package version (#9594) Co-authored-by: Xiaoxu Qi * Changes for EA invoice scenarios (#9508) * Added invoice download APIs. Added billing account-level invoice APIs for supporting EA invoices. * Fixed billing subscription invoice download scope * Added invoice rebillDetails * Reduced changes to those for supporting EA invoices * Reduced changes to those for supporting EA invoices 2 * Reduced changes to those for supporting EA invoices 3 * PR feedback * Added Cleared value for invoice status. * Changed invoice status Cleared to Void * Removed documents/source property from invoice example * documentation updates (#9583) * documentation updates * Reverting user impersonate value * Add readme.md for typescript sdk generation (#9339) * Update links in PULL_REQUEST_TEMPLATE.md (#9529) * Update links * Default unchecked * Update specificationRepositoryConfiguration.json (#9345) * Creating Labeler for Compute Updates (#9554) * Create label.yml * Create pr-labeler.yml * Update pr-labeler.yml * Update pr-labeler.yml * Rename pr-labeler.yml to labeler.yml * Update and rename label.yml to labelr.yml * Update labeler.yml * Update labelr.yml * Rename labelr.yml to labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * labeler for compute update * Update labeler.yml * Rename labeler.yml to ComputeReviewLabeler.yml * Update and rename labeler.yml to computeReviewLabeler.yml * Rename ComputeReviewLabeler.yml to computeReviewLabeler.yml * Update CODEOWNERS * Dev containerservice microsoft.container service 2020 04 01 (#9484) * Adds base for updating Microsoft.ContainerService from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * Support Node Image Version (#8865) * Add deprecated field to ContainerService GetAccessProfile 2020/04/01 API swagger (#9083) * Remove Low option from 04-01 API version (#9084) * Add a max surge upgrade setting (#9331) * [AKS] Apply patch from 0301 API version to 0401 (#9412) Co-authored-by: Xiaofang Zhang Co-authored-by: ruchikaguptaa Co-authored-by: Paul Miller Co-authored-by: Marwan Ahmed * Remove ISO8601 date format, ad current implementation uses another fo… (#9591) * Remove ISO8601 date format, ad current implementation uses another format and it breaks CLI. * One more date format change * [Hub Generated] Review request for Microsoft.AzureActiveDirectory to add version preview/2020-05-01-preview (#9458) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * making changes * Fixing errors * Fixing errors * Fixing build errors * Fixing pretty print * Adding Examples to the swagger review * Fixing semantic issues * removing code * removing required flags * Fixing Lint issues * Fixing Lint issues * Fixing build failures * Fixing build errors * grammer error fix * PR comments * fixing build * Fixing build errors * Fixing grammer * PR comments * Failing Validation Co-authored-by: animesh * regenerated all-api-versions * Cli onboard desktopvirtualization (#9531) * cli validation for desktopvirtualization * WIP * rename filter * correct example * rename extension * revert host-pool PATCH example * add expiredTime in RegistrationInfoPatch Co-authored-by: Changlong Liu * regenerated all-api-versions * BillingRP - Introducing the stable version (#9541) * BillingRP swagger * Changes for the GA version Changes for the GA version * Incorporated review comments Incorporated review comments * Fixed Prettier Check failures Fixed Prettier Check failures * Fixed Prettier Check failures Fixed Prettier Check failures * Added BillingSubscription patch Added BillingSubscription patch Co-authored-by: Anirban Sarkar * Speaker Recognition v2 (#9587) * Speaker Recognition v2 Split service into 2 APIs; Speaker Identification and Speaker Verification * Spelling mistakes fixed * Prettier run * add item name * Remove go support for now will add it later when we figure out the issue * regenerated all-api-versions * Update API specs 2020-04-01 (#9383) * Update API specs 2020-04-01 * Fix place * Fix version * Comments * Fix json * copy check files * Include old examples * Copy file over * Add files * Change version * Try reverting 2020-05-01 changes * Revert 2020-05-01 changes to test * Move version to end of file * Revert "Move version to end of file" This reverts commit 1c972299239680a2d350fabc4c177dda16eb9117. * Revert "Revert 2020-05-01 changes to test" This reverts commit ff0936aadbdf0842916fc9390b9395c7b232ad49. * Revert "Try reverting 2020-05-01 changes" This reverts commit f270e0d0e6e4be79bdccea36a6a1b50671354d0d. * Remove extra ``` * revert breaking 2020-05-01 change * Fix case * regenerated all-api-versions * Add async operation's api to storage cache RP (#9483) * Add basicpublishingcredentialspolicies to Microsoft.Web 2019-08-01 (#9250) * Add basicpublishingcredentialspolicies to Microsoft.Web stable 2019-08-01 * Made new resource a proxy only resource * Added missing reference * Addressing comments * Added examples * Removed description as a required field for SearchIndexerSkillset (#9588) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed description as a required field for SearchIndexerSkillset * add secondly (#9225) * Removed TextExtractionAlgorithm from OCRSkill (#9604) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed property TextExtractionAlgorithm (which is obsolete) and added property LineEnding to OCRSkill * Fixed bug with json escape characters and quoted default values in descriptions * Backing out changes for LineEnding, so we can get the TextExtractionAlgorithm removal in * Changed skill-related enums to strings for values that may change (#9621) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Changed skill-related enums to be strings for values that may change in the future * Add checkTrialAvailability endpoint to Microsoft.AVS manifest (#9618) Co-authored-by: David Ricciardi * update 2019-06-01-preview ManagedDatabases swagger file (#9535) * update 2019-06-01-preview ManagedDatabases swagger file * added newline to eof * Update script version for PPE pipeline (#9616) * Add free-form object spec for testing purpose. * Revert "Add free-form object spec for testing purpose." This reverts commit b711d809b6ae964fcbe7d04f31fec76db8798438. * Update script version for ppe pipeline. * added dismiss alerts and get single alert. (#9434) * [DataFactory] - Add xml dataset (#9615) * Add xml dataset * Fixed typo * Fixed typo * Fixed typo * Fixed prettier check issues * Removed namespaces in xml ReadSettings Co-authored-by: Shawn Xiao (IM) * add linked service and schema linked service to data flow source/sink (#9605) * add alert link to security alert arm model (#9566) * add alert link to security alert arm model * Add alert link to example file * Change to lowercase Co-authored-by: Amir Keren * EventHub: fixed the Cluster PUT API (#9596) * fixed the Cluster PUT API * fix examples * examples fix * example fixes * corrected example cluster_put Co-authored-by: v-ajnava * [AKS] re-apply the changes to making the count field optional to fix regressions (#9610) * Swagger for the new ARM resource PrivateLinkHub (#9482) * Swagger for the new ARM resource PrivateLinkHub * fix review comments * Added descriptions * prettier fixes * Add reference to json in readme * Add Patch operation * Added enum for Provisioning State * update example * regenerated all-api-versions * Fix output folder in peering (#9631) * Add Readme File for Container Registry (#9632) * Fix linter doc mistake (#9630) * update @azure/oad version to fix breaking issue * Adding 5 new lint rules * fix typo * fix typo Co-authored-by: Jianye Xi * Move serverVulnerabilityAssessment API to stable-2020-01-01 (#9097) * Move serverVulnerabilityAssessment API to stable-2020-01-01 * remove preview version * Removed API that is not reachable * fix conflicts * Add serverVA in missing parts * Add missing serverVA * revert readme * ASC: Move VA to 2020-01-01 * update GC Swagger spec to match with most recent service interface (#9595) * update Guestconfiguration Swagger spec to match with most recent service Api interface * fix auto check-Part1 * roll back style change * fix auto check-Part2 * fix auto check-Part3 * fix auto check-Part4 * fix auto check-Part5 * fix auto check-Part6 - readonly * fix auto check-Part7 * fix auto check-Part8 * fix auto check-Part9 -- error code * roll back to Part5 * roll back to Part5.1 * roll back to Part5.2 * roll back to Part5.3 * roll back to Part5.4 Co-authored-by: ge huang * Merge 7.2 into master (#9590) * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * full backup restore yaml changes (#8685) * Adding the required swagger file changes for full HSM backup Signed-off-by: vasanthrajams * Resolved a few semantic errors in pipeline Signed-off-by: vasanthrajams * Fixed incremental github pipeline model validation erors Signed-off-by: vasanthrajams * Fixed review comments & ci pipeline * spell check fix * pretty fix * Adding required headers as per azure async operations guidelines Signed-off-by: vasanthrajams * Fixed minor typos Signed-off-by: vasanthrajams Co-authored-by: vasanthrajams * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * fixing validation failures * key-version example fix * model validation Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams Co-authored-by: Hervey Wilson Co-authored-by: Rick Qing Xu * monitor readme fix (#9635) * [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9418) * added forecast api and all of it's scopes * removed extra external forecast example links * updated budgets api to reflect current version * fixed filter properties * fixed typos * cleaned up description * removed OR from budgetFilter * Revert "removed extra external forecast example links" This reverts commit b491abae116fd1e484b0b9d18fbe4bd86aec0fd2. * Revert "added forecast api and all of it's scopes" This reverts commit 6de98db14004d5701c56c42adcade4ee583c011b. * fixed Budgets as per PM's suggestions * renamed x-ms-enum name to avoid conflict * [DataFactory] Add GlobalParameters and update waitTimeInSeconds in WaitActivity (#9362) * Update data type of waitTimeInSeconds in WaitActivity * add global parameters Co-authored-by: Kang Tao * update identity type enum (#9649) Co-authored-by: Richard Li * Revert "Fix Parameter Description for validate resource move (#8524)" (#9580) This reverts commit cb0a81fefacc56fca338e3a2658a9390b305fa61. * Correcting the swagger to accept downloadToken similar to other download operations (#9651) Correcting the swagger to accept downloadToken similar to other download operations Co-authored-by: Anirban Sarkar * renaming operationIds fro Cluster put and patch as per guidelines (#9639) Co-authored-by: v-ajnava * Updating documentation of Quota APIs. Removing Summary field. (#9641) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. * Update CODEOWNERS (#9669) * add deleteFilesAfterCompletion to binary sources. add listAfter/listBefore to adls gen1 source (#9472) Co-authored-by: Haoran Sun * Fix bad output-folder (#9658) * enable rest-api-specs-scripts@0.10.2 (#9671) * Update API specs 2020-05-01 (#9542) * update 2020-05-01 version * Add samples * Update version * Update example * Fix case * regenerated all-api-versions * Event Grid: 2020-06-01 Swagger (#9629) * [HDInsight]-Add livyspark api spec for hdi. (#9469) * Add livyspark api spec for hdi. * Prettier check * Update code style. * fix comments * prettier check * Update the code in order to unify the naming rules. * updated AppServicePlan doc (#9679) * Kusto: update java readme (#9576) * Updating Patch API description. (#9676) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. * Updating Patch API description. * Patch description updated. * Update data share examples for consumer invitations (#9668) * update examples for consumer invitations with correct id * run prettier * Remove lt rv1 WaitForARMFeedback (#9247) * add readme.az for databoxedge (#9683) * add readme.az * add cli_extension * validate CLI codegen for databox (#9211) * validate databox * repo: azure-cli-extensions * relocate python config Co-authored-by: Changlong Liu * updated resources readme (#9638) * Update InfrastructureEncryption property description for PostgreSQL and MySQL (#9390) * Update InfrastructureEncryption property description for PostgreSQL and MySQL * Update InfrastructureEncryption property description for PostgreSQL and MySQL * Update allowed range for nodeCount (#9602) * Update allowed range for nodeCount * Remove minimum * Remove features mode (#9645) * Documentation fix (#9693) * Tables swagger fixes (#9584) * According to this PR https://github.com/Azure/azure-sdk-for-net/pull/7235 having Vision.FormRecognizer folder was mistake. (#8422) But this readme still contains vision and if you try to regenerate code in azure-sdk-for-net repository they would be created in Vision.FormRecognizer rather than just FormRecognizer. * init (#9667) * Onboard python track2 codegen (#9708) * align eTag with server (#9687) * align with server * revert for certain * IngestionMode Flag (#9654) * IngestionMode Flag * fix for missing bracket * diganostic with an A * Update property range due to tier sensitive. (#9422) Signed-off-by: Pan Li * fix swagger bug (#9709) * Update GraphQuery location property readOnly=false (#9568) * remove location readOnly property * set location readOnly false * Update bms.json (#9711) Azure Backup Health * Azure Digital Twins 2020-05-31-preview (#9622) * Azure Digital Twins 2020-05-31-preview swagger. * Updates. * Updates. * Update host name. * Add custom words. * Fix host name so that verification tools work. * Prettier updates. * Try file name without spaces. * Update md files. * Add missing api-version. * Fix readme.go.md. * [Synapse] - Update data plane Swagger specs (#9534) * Update Synapse Swagger data plane specs * Fix notebook * Create three clients in Readme * Update Readme for managed Vnet * Rename scheme name * Minor change * Update example * Rename development to artifact Co-authored-by: Dongwei Wang Co-authored-by: Laurent Mazuel * New API version for Iot Hub Get Endpoint Health (#9680) * Adds base for updating Microsoft.Devices from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * initial version * camel case * reviewed comments Co-authored-by: Juan Carpio Castellanos * remove whitespace (#9703) * remove whitespace * fix example Co-authored-by: Richard Li * Fix VirtualMachineScaleSetIPConfigurationProperties Load Balancer description (#9675) * add codegen config for GuesConfiguration (#9692) * add codegen config * enable pipeline * [Hub Generated] Review request for Microsoft.Databricks to add version stable/2018-04-01 (#9657) * 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction. (#9724) 2. Removing state=enabledForPreview. 3. Updating Example. * Add sql parallel read properties (#9712) * add httpRequestTimeout to odata based connector activities * add httpRequestTimeout to odata based connector activities * add sql parallel read properties * Custom vision 3 3 (#9522) * Establish base from previous version to compare against * Alphabetize paths * API Updates * Add missing error messages * Fix file type * Spelling fix * Run prettier * Update all apis * Changing aspects/opinions to optional properties from required proper… (#9702) * Changing aspects/opinions to optional properties from required properties * removing (Optional) description Co-authored-by: josuh * Adding the missing api-version parameter for move and validate move APIs. It is already part of the examples. (#9732) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Co-authored-by: Anirban Sarkar * Add Missing Json in Readme for Monitor (#9730) * Delete labeler (#9738) * Delete computeReviewLabeler.yml * Delete computeReviewLabeler.yml * Update CODEOWNERS * enable t2 generation (#9749) * enable t2 generation (#9756) * Added the allowed values to $select, $expand and $filter queries unde… (#9585) * Added the allowed values to $select, $expand and $filter queries under VMSS and to $select query for Avset * Adding allowed values in the corresponding descriptions field * changing the examples * DiskRP Swagger changes for 2020-05-01 (#9552) * baseline commit for disk.json * changes related to disk access, changes in disk encryption set for new api version, new examples related to disk access * adding few more examples, more changes to disk.json * prettier commit * few fixes * added more examples and fixed readme.md, fixed typos in disk.json * fixing readme * prettier fixes * fix ref to example * adding network access policy and diskAccessId to snapshots * fix readme.md * fixing enum descriptions * fixing enum description * fixing descriptions * fixing validations * fix swagger api version * reverting des change to make sourceVault optional * fix field name actionsRequired * fixing descryptions for encryption at rest * consolidating enums and fixing type * [Resources] Add new API version (#9487) * Initial commit with the old version * Add error proprty to DeploymentOperationProperties * Add enum values for provisioningState * Update provisioningState description * Update statusMessage property * Update api-version and parameters in examples * Update readme.md to refer to the new resources swagger * Prettier fix; we can Python sdk too * Added id and relativePath parameters to TemplateLink * update csharp and java read me files for the new API * Address Pr feedback * Examples for TemplateSpecs deployment * Unblock Java SDK generation * Fix examples for templatespecs * prettier fixes Co-authored-by: Filiz Topatan Co-authored-by: Gokul Premraj * Add multiapi support (#9759) * fixed examples and BudgetCategory as PM suggested (#9776) * Fix Error Response Structure (#9733) Co-authored-by: Zhenyu Zhou * Adding new resource type azureADMetrics (#9636) * Adds base for updating Microsoft.Aadiam from version preview/2020-03-01-preview to version 2020-07-01-preview * Updates readme * Updates API version in new specs and examples * added azureADHealth * rough commit (without examples) for azureADHealth * changed Ad to AD * added examples for azureadhealth * removed private link files from 2020-07-01 preview * examples updated for azureadhealth * removed alltenants and tenants params from examples * Fix Linting errors * Update readme to make avocado fix * minor fix * custom word addition * Update examples to match spec * Make PrivateLinkPolicyName parameter have same values to solve LintDiff error * Make subscriptionIdParameter identical in all json files * error fixes for all model errors * fixed model validation error * additional suppressions for pascal case and operations * added azureadhealth in readme to fix avocado error * added privatelink api version along with azureadhealth * changed api version to the filepath version * modified for corrections on AzureADHealthGet * aded changes to match spec and example * reverted passing commit from before * renamed to azureadmetrics * Readme changes * azureadmetrics custom word change * azureadmetrics file updates * properties * quick prettier fix * minor change to run tests again * addressing comments * location and tag changes * delete doesnt take in param * removed duplicate tag def * syntax check * comment changes, except the provisioningState change * provisioningstate property addition * provisioningState example fixes * properties fix * semantic validation error fix Co-authored-by: Hyewon Lee Co-authored-by: Abbe Blank * enable t2 generation (#9755) * enable t2 generation (#9752) * test support (#9741) * enable t2 generation (#9751) * Adding swagger for Template Specs (#9778) * Adding swagger for Template Specs * Running prettier to fix whitespace/newline alignments * enabling track2 generation (#9754) * Updates for FE changes Co-authored-by: Zach Rathbun Co-authored-by: TinaHu1 <51737887+TinaHu1@users.noreply.github.com> Co-authored-by: Alex Aloni Co-authored-by: Alex Dubinkov Co-authored-by: azuresdkci Co-authored-by: Arcturus Co-authored-by: shurd Co-authored-by: Sam Hurd Co-authored-by: annatisch Co-authored-by: datr93 <43795914+datr93@users.noreply.github.com> Co-authored-by: John Stairs Co-authored-by: Landon Smith Co-authored-by: navysingla <47647464+navysingla@users.noreply.github.com> Co-authored-by: Jiashuo Li Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni Co-authored-by: Zim Kalinowski Co-authored-by: Steve Stein Co-authored-by: Himanshu Chhabra Co-authored-by: Tosin Adewale Co-authored-by: Tosin Adewale Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Co-authored-by: Changlong Liu Co-authored-by: Tanyi Chen Co-authored-by: elabicha <61994320+elabicha@users.noreply.github.com> Co-authored-by: Phoenix He Co-authored-by: Cameron Taggart Co-authored-by: jspearman3 Co-authored-by: Praneeth Sanapathi Co-authored-by: Praneeth Sanapathi Co-authored-by: Ran Wang Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com> Co-authored-by: Jianye Xi Co-authored-by: ayfathim Co-authored-by: 陈箭飞 <32889038+chenjianfei2017@users.noreply.github.com> Co-authored-by: root Co-authored-by: Vivian Liu Co-authored-by: Allen Zhang Co-authored-by: Ashraf Hamad Co-authored-by: Ashraf Hamad Co-authored-by: Feiyu Shi <44449256+feiyushi@users.noreply.github.com> Co-authored-by: Vishnu Priya Ananthu Sundaram Co-authored-by: Yoram Singer <37076505+yoramsinger@users.noreply.github.com> Co-authored-by: Priyaranjan Pandey Co-authored-by: xiaoxu qi Co-authored-by: Xiaoxu Qi Co-authored-by: Junbo Wang Co-authored-by: Donald Liu <32778916+PakDLiu@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Marcin Jastrzebski Co-authored-by: Avinash Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: srilatha inavolu Co-authored-by: ivkule <59470194+ivkule@users.noreply.github.com> Co-authored-by: NourEldin Yasser <65115481+a-noyass@users.noreply.github.com> Co-authored-by: John Call Co-authored-by: Thomas Reis Co-authored-by: bob Co-authored-by: Paviya (Elle) Tojaroon Co-authored-by: Elle Tojaroon Co-authored-by: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav Co-authored-by: Jacob Hill Co-authored-by: Jacob Hill Co-authored-by: David Zhao <31305478+davidzhaoyue@users.noreply.github.com> Co-authored-by: David Zhao Co-authored-by: yibirnba <52132191+yibirnba@users.noreply.github.com> Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha Co-authored-by: Zihong Co-authored-by: Zhiyong Yang Co-authored-by: Meha Kaushik Co-authored-by: Meha Kaushik Co-authored-by: Arik Olsh <47111029+arolshan@users.noreply.github.com> Co-authored-by: Anthony Kunnel Jose Co-authored-by: erich-wang Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: Fernando Fonseca Co-authored-by: liemilyg <45784009+liemilyg@users.noreply.github.com> Co-authored-by: zhaomuzhi Co-authored-by: najagasi <49212852+najagasi@users.noreply.github.com> Co-authored-by: Namrata Jagasia Co-authored-by: Ajit Navasare Co-authored-by: v-ajnava Co-authored-by: orieldar Co-authored-by: aim-for-better Co-authored-by: Zhenyu Zhou Co-authored-by: Mark Young Co-authored-by: giakas Co-authored-by: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Co-authored-by: Richard Li Co-authored-by: Richard Li Co-authored-by: Yang Yuan Co-authored-by: pajind Co-authored-by: angaivor Co-authored-by: Zach Rathbun Co-authored-by: TinaHu1 <51737887+TinaHu1@users.noreply.github.com> Co-authored-by: Alex Aloni Co-authored-by: Alex Dubinkov Co-authored-by: azuresdkci Co-authored-by: Arcturus Co-authored-by: shurd Co-authored-by: Sam Hurd Co-authored-by: annatisch Co-authored-by: datr93 <43795914+datr93@users.noreply.github.com> Co-authored-by: John Stairs Co-authored-by: Landon Smith Co-authored-by: navysingla <47647464+navysingla@users.noreply.github.com> Co-authored-by: Jiashuo Li Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni Co-authored-by: Zim Kalinowski Co-authored-by: Steve Stein Co-authored-by: Himanshu Chhabra Co-authored-by: Tosin Adewale Co-authored-by: Tosin Adewale Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Co-authored-by: Changlong Liu Co-authored-by: Tanyi Chen Co-authored-by: elabicha <61994320+elabicha@users.noreply.github.com> Co-authored-by: Phoenix He Co-authored-by: Cameron Taggart Co-authored-by: jspearman3 Co-authored-by: Praneeth Sanapathi Co-authored-by: Praneeth Sanapathi Co-authored-by: Ran Wang Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com> Co-authored-by: Jianye Xi Co-authored-by: ayfathim Co-authored-by: 陈箭飞 <32889038+chenjianfei2017@users.noreply.github.com> Co-authored-by: root Co-authored-by: Vivian Liu Co-authored-by: Allen Zhang Co-authored-by: Ashraf Hamad Co-authored-by: Ashraf Hamad Co-authored-by: Feiyu Shi <44449256+feiyushi@users.noreply.github.com> Co-authored-by: Vishnu Priya Ananthu Sundaram Co-authored-by: Yoram Singer <37076505+yoramsinger@users.noreply.github.com> Co-authored-by: Priyaranjan Pandey Co-authored-by: xiaoxu qi Co-authored-by: Xiaoxu Qi Co-authored-by: Junbo Wang Co-authored-by: Donald Liu <32778916+PakDLiu@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Marcin Jastrzebski Co-authored-by: Avinash Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: srilatha inavolu Co-authored-by: ivkule <59470194+ivkule@users.noreply.github.com> Co-authored-by: NourEldin Yasser <65115481+a-noyass@users.noreply.github.com> Co-authored-by: John Call Co-authored-by: Thomas Reis Co-authored-by: bob Co-authored-by: Paviya (Elle) Tojaroon Co-authored-by: Elle Tojaroon Co-authored-by: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav Co-authored-by: Jacob Hill Co-authored-by: Jacob Hill Co-authored-by: David Zhao <31305478+davidzhaoyue@users.noreply.github.com> Co-authored-by: David Zhao Co-authored-by: yibirnba <52132191+yibirnba@users.noreply.github.com> Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha Co-authored-by: Zihong Co-authored-by: Zhiyong Yang Co-authored-by: Meha Kaushik Co-authored-by: Meha Kaushik Co-authored-by: Arik Olsh <47111029+arolshan@users.noreply.github.com> Co-authored-by: Anthony Kunnel Jose Co-authored-by: erich-wang Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: Fernando Fonseca Co-authored-by: liemilyg <45784009+liemilyg@users.noreply.github.com> Co-authored-by: zhaomuzhi Co-authored-by: najagasi <49212852+najagasi@users.noreply.github.com> Co-authored-by: Namrata Jagasia Co-authored-by: Ajit Navasare Co-authored-by: v-ajnava Co-authored-by: orieldar Co-authored-by: aim-for-better Co-authored-by: Zhenyu Zhou Co-authored-by: Mark Young Co-authored-by: giakas Co-authored-by: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Co-authored-by: Richard Li Co-authored-by: Richard Li Co-authored-by: Yang Yuan Co-authored-by: pajind Co-authored-by: srcharug <62158390+srcharug@users.noreply.github.com> Co-authored-by: docohe <54349195+docohe@users.noreply.github.com> Co-authored-by: Nate Lehman Co-authored-by: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com> Co-authored-by: zhanyu2014 Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: Liran Chen <1437075+liranc@users.noreply.github.com> Co-authored-by: Liran Chen Co-authored-by: Saif Kayani Co-authored-by: Lakshmi Priya Sekar Co-authored-by: Xiaoyun Ding Co-authored-by: Xiaoyun Ding Co-authored-by: chunyu3 Co-authored-by: jbuls <48029054+jbuls@users.noreply.github.com> Co-authored-by: sarajang <37909871+sarajang@users.noreply.github.com> Co-authored-by: Theodore Chang Co-authored-by: Frank Gao <4760010+gtxistxgao@users.noreply.github.com> Co-authored-by: Xiaofang Zhang Co-authored-by: ruchikaguptaa Co-authored-by: Paul Miller Co-authored-by: Marwan Ahmed Co-authored-by: animeshseth90 <64622013+animeshseth90@users.noreply.github.com> Co-authored-by: animesh Co-authored-by: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Co-authored-by: Anirban Sarkar Co-authored-by: Youssef Shahin Co-authored-by: digavino <48699384+digavino@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: Shubham Dhond Co-authored-by: Jennifer Marsman Co-authored-by: Xia ZHU <398289931@qq.com> Co-authored-by: David Co-authored-by: David Ricciardi Co-authored-by: xaliciayang <59986952+xaliciayang@users.noreply.github.com> Co-authored-by: Ray Chen Co-authored-by: sashahdo <64434373+sashahdo@users.noreply.github.com> Co-authored-by: shawnxzq Co-authored-by: Shawn Xiao (IM) Co-authored-by: Richard Zhang Co-authored-by: Amir Keren Co-authored-by: Amir Keren Co-authored-by: sugandhaamic <65259091+sugandhaamic@users.noreply.github.com> Co-authored-by: Liang Wang Co-authored-by: Amit Aviram Co-authored-by: Ge Huang Co-authored-by: ge huang Co-authored-by: vasanthrajams <60414148+vasanthrajams@users.noreply.github.com> Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams Co-authored-by: Hervey Wilson Co-authored-by: Rick Qing Xu Co-authored-by: kangtao Co-authored-by: Kang Tao Co-authored-by: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Co-authored-by: Kamil Sobol <61715331+kasobol-msft@users.noreply.github.com> Co-authored-by: rickysun93 Co-authored-by: Haoran Sun Co-authored-by: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Co-authored-by: gkgaurav31 Co-authored-by: Chuang <54572251+xccc-msft@users.noreply.github.com> Co-authored-by: bradrich-msft <53872276+bradrich-msft@users.noreply.github.com> Co-authored-by: Shinil Mannadath Co-authored-by: Dongwei Wang Co-authored-by: Raouf Merouche Co-authored-by: Ivan Matantsev Co-authored-by: tofriedl <50571149+tofriedl@users.noreply.github.com> Co-authored-by: Pan Li Co-authored-by: xuzhang3 <57888764+xuzhang3@users.noreply.github.com> Co-authored-by: lapradh <66009265+lapradh@users.noreply.github.com> Co-authored-by: Brian Crawford Co-authored-by: Dongwei Wang Co-authored-by: Laurent Mazuel Co-authored-by: jucarpio <57114852+jucarpio@users.noreply.github.com> Co-authored-by: Juan Carpio Castellanos Co-authored-by: Cecile Robert-Michon Co-authored-by: Rodge Fu Co-authored-by: Subrahmanyam Mandavilli Co-authored-by: Andrew <30499261+areddish@users.noreply.github.com> Co-authored-by: Joohee Suh <58048046+josuhazure@users.noreply.github.com> Co-authored-by: josuh Co-authored-by: chetmaddula <57730350+chetmaddula@users.noreply.github.com> Co-authored-by: Filiz Topatan Co-authored-by: Filiz Topatan Co-authored-by: Gokul Premraj Co-authored-by: Hyewon Lee Co-authored-by: Hyewon Lee Co-authored-by: Abbe Blank Co-authored-by: stuartko <47676853+stuartko@users.noreply.github.com> --- .../v2.1-preview.1/FormRecognizer.json | 1967 +++++++++++++++++ .../v2.1-preview.1/examples/AnalyzeBatch.json | 16 + .../examples/AnalyzeOperationResult.json | 25 + .../examples/BusinessCardBatch.json | 17 + .../examples/BusinessCardBatchResult.json | 24 + .../examples/ComposeModels.json | 21 + .../v2.1-preview.1/examples/CopyModel.json | 25 + .../examples/CopyModelAuthorization.json | 20 + .../examples/CopyOperationResult.json | 23 + .../CopyOperationResultWithErrors.json | 28 + .../v2.1-preview.1/examples/DeleteModel.json | 11 + .../v2.1-preview.1/examples/GetModel.json | 59 + .../v2.1-preview.1/examples/GetModels.json | 43 + .../examples/GetModelsSummary.json | 20 + .../v2.1-preview.1/examples/LayoutBatch.json | 16 + .../examples/LayoutBatchResult.json | 22 + .../examples/ReceiptsBatch.json | 15 + .../examples/ReceiptsBatchResult.json | 24 + .../v2.1-preview.1/examples/TrainBatch.json | 18 + .../examples/TrainBatchWithSubFolders.json | 23 + .../data-plane/FormRecognizer/readme.go.md | 4 +- .../data-plane/FormRecognizer/readme.md | 9 +- 22 files changed, 2427 insertions(+), 3 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json new file mode 100644 index 000000000000..9c401eb68afe --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json @@ -0,0 +1,1967 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.1-preview.1", + "title": "Form Recognizer Client", + "description": "Extracts information from forms and images into structured data." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/formrecognizer/v2.1-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/custom/models": { + "post": { + "summary": "Train Custom Model", + "description": "Create and train a custom model. The request must include a source parameter that is either an externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri) or valid path to a data folder in a locally mounted drive. When local paths are specified, they must follow the Linux/Unix path format and be an absolute path rooted to the input mount configuration setting value e.g., if '{Mounts:Input}' configuration setting value is '/input' then a valid source path would be '/input/contosodataset'. All data to be trained is expected to be under the source folder or sub folders under it. Models are trained using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff'. Other type of content is ignored.", + "operationId": "TrainCustomModelAsync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "trainRequest", + "in": "body", + "description": "Training request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TrainRequest" + } + } + ], + "responses": { + "201": { + "description": "Request is queued successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the model being trained. The status of model training is specified in the status property at the model location." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Train custom model": { + "$ref": "./examples/TrainBatch.json" + }, + "Train custom model with subfolder filter options": { + "$ref": "./examples/TrainBatchWithSubFolders.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}": { + "get": { + "summary": "Get Custom Model", + "description": "Get detailed information about a custom model.", + "operationId": "GetCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeKeys", + "in": "query", + "description": "Include list of extracted keys in model information.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get custom model": { + "$ref": "./examples/GetModel.json" + } + } + }, + "delete": { + "summary": "Delete Custom Model", + "description": "Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.", + "operationId": "DeleteCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "Successfully marked model for deletion. Model artifacts will be removed within a predefined time period." + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete custom model": { + "$ref": "./examples/DeleteModel.json" + } + } + } + }, + "/custom/models/{modelId}/analyze": { + "post": { + "summary": "Analyze Form", + "description": "Extract key-value pairs, tables, and semantic values 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": "AnalyzeWithCustomModel", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "$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 form with custom model": { + "$ref": "./examples/AnalyzeBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Form Result", + "description": "Obtain current status and the result of the analyze form operation.", + "operationId": "GetAnalyzeFormResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "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 form result": { + "$ref": "./examples/AnalyzeOperationResult.json" + } + } + } + }, + "/custom/models/{modelId}/copy": { + "post": { + "summary": "Copy Custom Model", + "description": "Copy custom model stored in this resource (the source) to user specified target Form Recognizer resource.", + "operationId": "CopyCustomModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "copyRequest", + "in": "body", + "description": "Copy request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CopyRequest" + } + } + ], + "responses": { + "202": { + "description": "Copy 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 copy operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Copy custom model": { + "$ref": "./examples/CopyModel.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}/copyResults/{resultId}": { + "get": { + "summary": "Get Custom Model Copy Result", + "description": "Obtain current status and the result of a custom model copy operation.", + "operationId": "GetCustomModelCopyResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "resultId", + "in": "path", + "description": "Copy operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CopyOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get copy custom model result": { + "$ref": "./examples/CopyOperationResult.json" + }, + "Get copy custom model result with failures": { + "$ref": "./examples/CopyOperationResultWithErrors.json" + } + } + } + }, + "/custom/models/copyAuthorization": { + "post": { + "summary": "Generate Copy Authorization", + "description": "Generate authorization to copy a model into the target Form Recognizer resource.", + "operationId": "GenerateModelCopyAuthorization", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "201": { + "description": "Copy request is authorized successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the model being copied. The status of model copy is specified in the status property at the model location." + } + }, + "schema": { + "$ref": "#/definitions/CopyAuthorizationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Copy custom model": { + "$ref": "./examples/CopyModelAuthorization.json" + } + } + } + }, + "/custom/models/compose": { + "post": { + "tags": [ + "Form" + ], + "summary": "Compose trained with labels models into one composed model.", + "description": "Compose request would include list of models ids.\r\nIt would validate what all models either trained with labels model or composed model.\r\nIt would validate limit of models put together.", + "operationId": "ComposeCustomModelsAsync", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "composeRequest", + "in": "body", + "description": "Compose models", + "required": true, + "schema": { + "$ref": "#/definitions/ComposeRequest" + } + } + ], + "responses": { + "201": { + "description": "Request is queued successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the composed model. The status of composed model is specified in the status property at the model location." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Compose custom models": { + "$ref": "./examples/ComposeModels.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/businessCard/analyze": { + "post": { + "summary": "Analyze Business Card", + "description": "Extract field text and semantic values from a given business card 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) of the document to be analyzed.", + "operationId": "AnalyzeBusinessCardAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "name": "locale", + "in": "query", + "description": "Locale of the business card. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default).", + "required": false, + "type": "string" + }, + { + "$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 Business Card": { + "$ref": "./examples/BusinessCardBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/businessCard/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Business Card Result", + "description": "Track the progress and obtain the result of the analyze business card operation.", + "operationId": "GetAnalyzeBusinessCardResult", + "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 business card result": { + "$ref": "./examples/BusinessCardBatchResult.json" + } + } + } + }, + "/prebuilt/receipt/analyze": { + "post": { + "summary": "Analyze Receipt", + "description": "Extract field text and semantic values from a given receipt 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) of the document to be analyzed.", + "operationId": "AnalyzeReceiptAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "name": "locale", + "in": "query", + "description": "Locale of the receipt. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default).", + "required": false, + "type": "string" + }, + { + "$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 receipt": { + "$ref": "./examples/ReceiptsBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/receipt/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Receipt Result", + "description": "Track the progress and obtain the result of the analyze receipt operation.", + "operationId": "GetAnalyzeReceiptResult", + "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 receipt result": { + "$ref": "./examples/ReceiptsBatchResult.json" + } + } + } + }, + "/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" + } + }, + "x-ms-long-running-operation": true + } + }, + "/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" + } + } + } + } + }, + "x-ms-paths": { + "/custom/models?op=full": { + "get": { + "summary": "List Custom Models", + "description": "Get information about all custom models", + "operationId": "ListCustomModels", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "op", + "in": "query", + "description": "Specify whether to return summary or full list of models.", + "required": true, + "type": "string", + "enum": [ + "full" + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Models" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "modelList" + }, + "x-ms-examples": { + "List custom models": { + "$ref": "./examples/GetModels.json" + } + } + } + }, + "/custom/models?op=summary": { + "get": { + "summary": "Get Custom Models", + "description": "Get information about all custom models", + "operationId": "GetCustomModels", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "op", + "in": "query", + "description": "Specify whether to return summary or full list of models.", + "required": true, + "type": "string", + "enum": [ + "summary" + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Models" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get models summary": { + "$ref": "./examples/GetModelsSummary.json" + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "type": "string", + "description": "Status of the queued operation.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "CopyAuthorizationResult": { + "description": "Request parameter that contains authorization claims for copy operation.", + "required": [ + "modelId", + "accessToken", + "expirationDateTimeTicks" + ], + "type": "object", + "properties": { + "modelId": { + "description": "Model identifier.", + "type": "string" + }, + "accessToken": { + "description": "Token claim used to authorize the request.", + "type": "string" + }, + "expirationDateTimeTicks": { + "description": "The time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time.", + "type": "integer", + "format": "int64" + } + } + }, + "CopyRequest": { + "description": "Request parameter to copy an existing custom model from the source resource to a target resource referenced by the resource ID.", + "required": [ + "targetResourceId", + "targetResourceRegion", + "copyAuthorization" + ], + "type": "object", + "properties": { + "targetResourceId": { + "description": "Azure Resource Id of the target Form Recognizer resource where the model is copied to.", + "maxLength": 1024, + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$", + "x-ms-azure-resource": true + }, + "targetResourceRegion": { + "description": "Location of the target Azure resource. A valid Azure region name supported by Cognitive Services.", + "type": "string", + "pattern": "^[a-z0-9]+$", + "minLength": 1, + "maxLength": 24 + }, + "copyAuthorization": { + "description": "Entity that encodes claims to authorize the copy request.", + "$ref": "#/definitions/CopyAuthorizationResult" + } + } + }, + "CopyOperationResult": { + "description": "Status and result of the queued copy operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the copy operation was submitted.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "copyResult": { + "description": "Results of the copy operation.", + "$ref": "#/definitions/CopyResult" + } + } + }, + "CopyResult": { + "description": "Custom model copy result.", + "type": "object", + "required": [ + "modelId" + ], + "properties": { + "modelId": { + "description": "Identifier of the target model.", + "type": "string", + "format": "uuid" + }, + "errors": { + "description": "Errors returned during the copy operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "AnalyzeOperationResult": { + "description": "Status and result of the queued analyze operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the analyze operation was submitted.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "analyzeResult": { + "description": "Results of the analyze operation.", + "$ref": "#/definitions/AnalyzeResult" + } + } + }, + "ModelName": { + "description": "Optional user defined model name (max length: 1024).", + "type": "string", + "x-nullable": false + }, + "TrainRequest": { + "description": "Request parameter to train a new custom model.", + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "description": "Source path containing the training documents.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "sourceFilter": { + "$ref": "#/definitions/TrainSourceFilter", + "description": "Filter to apply to the documents in the source path for training." + }, + "useLabelFile": { + "description": "Use label file for training a model.", + "type": "boolean", + "default": false + }, + "modelName": { + "$ref": "#/definitions/ModelName" + } + } + }, + "TrainSourceFilter": { + "description": "Filter to apply to the documents in the source path for training.", + "type": "object", + "properties": { + "prefix": { + "description": "A case-sensitive prefix string to filter documents in the source path for training. For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for training.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "includeSubFolders": { + "description": "A flag to indicate if sub folders within the set of prefix folders will also need to be included when searching for content to be preprocessed.", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "TrainResult": { + "description": "Custom model training result.", + "type": "object", + "required": [ + "trainingDocuments" + ], + "properties": { + "trainingDocuments": { + "description": "List of the documents used to train the model and any errors reported in each document.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingDocumentInfo" + } + }, + "fields": { + "description": "List of fields used to train the model and the train operation error reported by each.", + "type": "array", + "items": { + "$ref": "#/definitions/FormFieldsReport" + } + }, + "averageModelAccuracy": { + "description": "Average accuracy.", + "type": "number", + "x-nullable": false + }, + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "errors": { + "description": "Errors returned during the training operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "SourcePath": { + "description": "Uri or local path to source data.", + "type": "object", + "properties": { + "source": { + "description": "File source path.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + } + }, + "Attributes": { + "description": "Optional model attributes.", + "type": "object", + "properties": { + "isComposed": { + "description": "Is this model composed? (default: false).", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "ModelInfo": { + "description": "Basic custom model information.", + "type": "object", + "required": [ + "modelId", + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "status": { + "description": "Status of the model.", + "enum": [ + "creating", + "ready", + "invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the model was created.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "modelName": { + "$ref": "#/definitions/ModelName" + }, + "attributes": { + "$ref": "#/definitions/Attributes" + } + } + }, + "Models": { + "description": "Response to the list custom models operation.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of all trained custom models.", + "type": "object", + "required": [ + "count", + "limit", + "lastUpdatedDateTime" + ], + "properties": { + "count": { + "description": "Current count of trained custom models.", + "type": "integer", + "x-nullable": false + }, + "limit": { + "description": "Max number of models that can be trained for this account.", + "type": "integer", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the summary was last updated.", + "type": "string", + "x-nullable": false + } + } + }, + "modelList": { + "description": "Collection of trained custom models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfo" + } + }, + "nextLink": { + "description": "Link to the next page of custom models.", + "type": "string" + } + } + }, + "Model": { + "description": "Response to the get custom model operation.", + "type": "object", + "required": [ + "modelInfo" + ], + "properties": { + "modelInfo": { + "$ref": "#/definitions/ModelInfo" + }, + "keys": { + "$ref": "#/definitions/KeysResult" + }, + "trainResult": { + "description": "Training result for custom model.", + "$ref": "#/definitions/TrainResult" + }, + "composedTrainResults": { + "type": "array", + "description": "Training result for composed model.", + "items": { + "$ref": "#/definitions/TrainResult" + } + } + } + }, + "KeysResult": { + "description": "Keys extracted by the custom model.", + "type": "object", + "required": [ + "clusters" + ], + "properties": { + "clusters": { + "description": "Object mapping clusterIds to a list of keys.", + "type": "object", + "additionalProperties": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string" + } + } + } + } + }, + "TrainingDocumentInfo": { + "description": "Report for a custom model training document.", + "type": "object", + "required": [ + "documentName", + "pages", + "errors", + "status" + ], + "properties": { + "documentName": { + "description": "Training document name.", + "type": "string" + }, + "pages": { + "format": "int32", + "description": "Total number of pages trained.", + "type": "integer", + "x-nullable": false + }, + "errors": { + "description": "List of errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + }, + "status": { + "description": "Status of the training operation.", + "enum": [ + "succeeded", + "partiallySucceeded", + "failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainStatus", + "modelAsString": false + }, + "x-nullable": false + } + } + }, + "FormFieldsReport": { + "description": "Report for a custom model training field.", + "type": "object", + "required": [ + "fieldName", + "accuracy" + ], + "properties": { + "fieldName": { + "description": "Training field name.", + "type": "string" + }, + "accuracy": { + "description": "Estimated extraction accuracy for this field.", + "type": "number", + "x-nullable": false + } + } + }, + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/definitions/ErrorInformation" + } + } + }, + "ErrorInformation": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "ComposeRequest": { + "description": "Request contract for compose operation.", + "required": [ + "modelIds" + ], + "type": "object", + "properties": { + "modelIds": { + "description": "List of model ids to compose.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + }, + "modelName": { + "$ref": "#/definitions/ModelName" + } + } + }, + "AnalyzeResult": { + "description": "Analyze operation result.", + "type": "object", + "required": [ + "version", + "readResults" + ], + "properties": { + "version": { + "description": "Version of schema used for this result.", + "type": "string" + }, + "readResults": { + "description": "Text extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/ReadResult" + } + }, + "pageResults": { + "description": "Page-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/PageResult" + } + }, + "documentResults": { + "description": "Document-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentResult" + } + }, + "errors": { + "description": "List of errors reported during the analyze operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "ReadResult": { + "description": "Text extracted from a page in the input document.", + "type": "object", + "required": [ + "page", + "angle", + "width", + "height", + "unit" + ], + "properties": { + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "angle": { + "description": "The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].", + "type": "number", + "minimum": -180, + "maximum": 180, + "exclusiveMinimum": true, + "x-nullable": false + }, + "width": { + "description": "The width of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "height": { + "description": "The height of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "unit": { + "description": "The unit used by the width, height and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", + "type": "string", + "enum": [ + "pixel", + "inch" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": false + }, + "x-nullable": false + }, + "language": { + "description": "The detected language on the page overall.", + "$ref": "#/definitions/Language" + }, + "lines": { + "description": "When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.", + "type": "array", + "items": { + "$ref": "#/definitions/TextLine" + } + }, + "selectionMarks": { + "description": "List of selection marks extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/SelectionMark" + } + } + } + }, + "Language": { + "description": "Language code", + "type": "string", + "enum": [ + "en", + "es" + ], + "x-ms-enum": { + "name": "Language", + "modelAsString": true + }, + "x-nullable": false + }, + "TextLine": { + "description": "An object representing an extracted text line.", + "type": "object", + "required": [ + "text", + "boundingBox", + "words" + ], + "properties": { + "text": { + "description": "The text content of the line.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted line.", + "$ref": "#/definitions/BoundingBox" + }, + "language": { + "description": "The detected language of this line, if different from the overall page language.", + "$ref": "#/definitions/Language" + }, + "words": { + "description": "List of words in the text line.", + "type": "array", + "items": { + "$ref": "#/definitions/TextWord" + } + } + } + }, + "TextWord": { + "description": "An object representing a word.", + "type": "object", + "required": [ + "boundingBox", + "text" + ], + "properties": { + "text": { + "description": "The text content of the word.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted word.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "BoundingBox": { + "description": "Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.", + "type": "array", + "minItems": 8, + "maxItems": 8, + "items": { + "type": "number", + "x-nullable": false + } + }, + "PageResult": { + "description": "Extracted information from a single page.", + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "description": "Page number.", + "type": "integer", + "format": "int32", + "minimum": 1, + "x-nullable": false + }, + "clusterId": { + "description": "Cluster identifier.", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": false + }, + "keyValuePairs": { + "description": "List of key-value pairs extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValuePair" + } + }, + "tables": { + "description": "List of data tables extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTable" + } + } + } + }, + "KeyValuePair": { + "description": "Information about the extracted key-value pair.", + "type": "object", + "required": [ + "key", + "value", + "confidence" + ], + "properties": { + "label": { + "description": "A user defined label for the key/value pair entry.", + "type": "string" + }, + "key": { + "description": "Information about the extracted key in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "value": { + "description": "Information about the extracted value in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "KeyValueElement": { + "description": "Information about the extracted key or value in a key-value pair.", + "type": "object", + "required": [ + "text" + ], + "properties": { + "type": { + "$ref": "#/definitions/KeyValueType" + }, + "text": { + "description": "The text content of the key or value.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the key or value.", + "$ref": "#/definitions/BoundingBox" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + } + } + }, + "KeyValueType": { + "type": "string", + "description": "Semantic data type of the key value element.", + "enum": [ + "string", + "selectionMark" + ], + "x-ms-enum": { + "name": "KeyValueType", + "modelAsString": true + }, + "x-nullable": false + }, + "ElementReference": { + "description": "Reference to a line, word or selection mark.", + "type": "string" + }, + "SelectionMark": { + "description": "Information about the extracted selection mark.", + "type": "object", + "required": [ + "boundingBox", + "confidence", + "state" + ], + "properties": { + "boundingBox": { + "description": "Bounding box of the selection mark.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + }, + "state": { + "description": "State of the selection mark.", + "type": "string", + "enum": [ + "selected", + "unselected" + ] + } + } + }, + "DataTable": { + "description": "Information about the extracted table contained in a page.", + "type": "object", + "required": [ + "rows", + "columns", + "cells" + ], + "properties": { + "rows": { + "description": "Number of rows.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "columns": { + "description": "Number of columns.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "cells": { + "description": "List of cells contained in the table.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTableCell" + } + } + } + }, + "DataTableCell": { + "description": "Information about the extracted cell in a table.", + "type": "object", + "required": [ + "rowIndex", + "columnIndex", + "text", + "boundingBox", + "confidence" + ], + "properties": { + "rowIndex": { + "description": "Row index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "columnIndex": { + "description": "Column index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "rowSpan": { + "description": "Number of rows spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "columnSpan": { + "description": "Number of columns spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "text": { + "description": "Text content of the cell.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the cell.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this table cell.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "isHeader": { + "description": "Is the current cell a header cell?", + "type": "boolean", + "default": false, + "x-nullable": false + }, + "isFooter": { + "description": "Is the current cell a footer cell?", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "DocumentResult": { + "description": "A set of extracted fields corresponding to the input document.", + "type": "object", + "required": [ + "docType", + "pageRange", + "fields" + ], + "properties": { + "docType": { + "description": "Document type.", + "type": "string" + }, + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "pageRange": { + "description": "First and last page number where the document is found.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "integer", + "minimum": 1, + "x-nullable": false + } + }, + "docTypeConfidence": { + "description": "Predicted document type confidence.", + "$ref": "#/definitions/Confidence" + }, + "fields": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + } + } + }, + "FieldValue": { + "description": "Recognized field value.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of field value.", + "$ref": "#/definitions/FieldValueType" + }, + "valueString": { + "description": "String value.", + "type": "string" + }, + "valueDate": { + "description": "Date value.", + "format": "date", + "type": "string", + "x-nullable": false + }, + "valueTime": { + "description": "Time value.", + "format": "time", + "type": "string", + "x-nullable": false + }, + "valuePhoneNumber": { + "description": "Phone number value.", + "type": "string" + }, + "valueNumber": { + "description": "Floating point value.", + "type": "number", + "x-nullable": false + }, + "valueInteger": { + "description": "Integer value.", + "type": "integer", + "x-nullable": false + }, + "valueArray": { + "description": "Array of field values.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + }, + "valueObject": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + }, + "valueSelectionMark": { + "description": "Selection mark value.", + "type": "string", + "enum": [ + "selected", + "unselected" + ], + "x-nullable": false + }, + "text": { + "description": "Text content of the extracted field.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the field value, if appropriate.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence score.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this field.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + } + } + }, + "FieldValueType": { + "type": "string", + "description": "Semantic data type of the field value.", + "enum": [ + "string", + "date", + "time", + "phoneNumber", + "number", + "integer", + "array", + "object", + "selectionMark" + ], + "x-ms-enum": { + "name": "FieldValueType", + "modelAsString": false + }, + "x-nullable": false + }, + "Confidence": { + "description": "Confidence value.", + "type": "number", + "minimum": 0, + "maximum": 1, + "x-nullable": false + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "FileStream": { + "name": "fileStream", + "description": ".json, .pdf, .jpg, .png or .tiff type file stream.", + "x-ms-parameter-location": "method", + "in": "body", + "schema": { + "$ref": "#/definitions/SourcePath" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json new file mode 100644 index 000000000000..01eb4730ed08 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json new file mode 100644 index 000000000000..5b8a65ac0a6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json new file mode 100644 index 000000000000..6521a5fa2244 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": { + "source": "http://www.example.com/image.jpg" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/prebuilt/businessCard/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json new file mode 100644 index 000000000000..2cf7aa15db22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json new file mode 100644 index 000000000000..0fecac98f79b --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "composeRequest": { + "modelIds": [ + "4afb20d6-3ed0-4cde-ba40-dbd6207268dd", + "6f841356-aa32-42c9-a739-2182c47b79c9" + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json new file mode 100644 index 000000000000..34d6aacb688e --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {}, + "copyRequest": { + "targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}", + "targetResourceRegion": "westus2", + "copyAuthorization": { + "modelId": "{modelId}", + "accessToken": "{accessToken}", + "expirationDateTimeTicks": 637190189980000000 + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}/copyResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json new file mode 100644 index 000000000000..2acc95b1fce5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + }, + "body": { + "modelId": "{modelId}", + "accessToken": "{accessToken}", + "expirationDateTimeTicks": 637190189980000000 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json new file mode 100644 index 000000000000..f7b7b1163884 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{resultId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2020-01-01T00:00:00Z", + "lastUpdatedDateTime": "2020-01-01T00:01:00Z", + "copyResult": { + "modelId": "{modelId}", + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json new file mode 100644 index 000000000000..853dd73e595e --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{resultId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "failed", + "createdDateTime": "2020-01-01T00:00:00Z", + "lastUpdatedDateTime": "2020-01-01T00:01:00Z", + "copyResult": { + "modelId": "{modelId}", + "errors": [ + { + "code": "ResourceResolverError", + "message": "{ErrorMessage}" + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json new file mode 100644 index 000000000000..c945ec953dd4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json new file mode 100644 index 000000000000..df1c4b66b252 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "modelInfo": { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "modelName": "my composed model", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": true + } + }, + "keys": { + "clusters": { + "0": [ + "Invoice", + "123112313" + ], + "1": [ + "Please remit payment to:", + "Microsoft" + ] + } + }, + "trainResult": { + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + }, + "composedTrainResults": [ + { + "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd", + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + }, + { + "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9", + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json new file mode 100644 index 000000000000..36ee11465e4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "op": "full", + "body": {} + }, + "responses": { + "200": { + "body": { + "summary": { + "count": 2, + "limit": 5000, + "lastUpdatedDateTime": "2019-05-01T10:53:21Z" + }, + "modelList": [ + { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "modelName": "test model 1", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": false + } + }, + { + "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8", + "modelName": "test model 2", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": true + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json new file mode 100644 index 000000000000..507495b78206 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "op": "summary", + "body": {} + }, + "responses": { + "200": { + "body": { + "summary": { + "count": 5, + "limit": 5000, + "lastUpdatedDateTime": "2019-05-01T10:53:21Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json new file mode 100644 index 000000000000..1495017a7252 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "language": "en", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/layout/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json new file mode 100644 index 000000000000..2a258bfe71bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json new file mode 100644 index 000000000000..0790699b3fac --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/prebuilt/receipt/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json new file mode 100644 index 000000000000..2cf7aa15db22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json new file mode 100644 index 000000000000..b67143b72085 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json new file mode 100644 index 000000000000..ec88bff4f0d5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1", + "sourceFilter": { + "prefix": "", + "includeSubFolders": false + }, + "useLabelFile": false + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md index 1f5392f74b54..a3f839b98e64 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md +++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md @@ -1,4 +1,4 @@ -## Go +### Go These settings apply only when `--go` is specified on the command line. @@ -23,4 +23,4 @@ Please also specify `--go-sdk-folder=