{"note":"OpenAPI conversion -- returning structured metadata","name":"microsoft-com-cognitiveservices-ocr","description":"Computer Vision Client","version":"2.1","base_url":"https://westcentralus.api.cognitive.microsoft.com/vision/v2.1","endpoints":4,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Computer Vision Client\n@base https://westcentralus.api.cognitive.microsoft.com/vision/v2.1\n@version 2.1\n@auth ApiKey Ocp-Apim-Subscription-Key in header\n@endpoints 4\n@toc recognizeText(1), textOperations(1), read(2)\n\n@group recognizeText\n@endpoint POST /recognizeText\n@desc Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.\n@required {ImageUrl: map # A JSON document with a URL pointing to the image that is to be analyzed., mode: any # Type of text to recognize.}\n@returns(202) The service has accepted the request and will start processing later. It will return Accepted immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.\n\n@endgroup\n\n@group textOperations\n@endpoint GET /textOperations/{operationId}\n@desc This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.\n@required {operationId: any # Id of the text operation returned in the response of the 'Recognize Text'}\n@returns(200) Returns the operation status.\n\n@endgroup\n\n@group read\n@endpoint POST /read/core/asyncBatchAnalyze\n@desc Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​\n@required {ImageUrl: map # A JSON document with a URL pointing to the image that is to be analyzed.}\n@returns(202) The service has accepted the request and will start processing later.\n\n@endpoint GET /read/operations/{operationId}\n@desc This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface.\n@required {operationId: any # Id of read operation returned in the response of the 'Batch Read File' interface.}\n@returns(200) Returns the read operation status.\n\n@endgroup\n\n@end\n"}