@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Computer Vision Client
@base https://westcentralus.api.cognitive.microsoft.com/vision/v2.1
@version 2.1
@auth ApiKey Ocp-Apim-Subscription-Key in header
@endpoints 4
@toc recognizeText(1), textOperations(1), read(2)

@group recognizeText
@endpoint POST /recognizeText
@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.
@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.}
@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.

@endgroup

@group textOperations
@endpoint GET /textOperations/{operationId}
@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.
@required {operationId: any # Id of the text operation returned in the response of the 'Recognize Text'}
@returns(200) Returns the operation status.

@endgroup

@group read
@endpoint POST /read/core/asyncBatchAnalyze
@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.​
@required {ImageUrl: map # A JSON document with a URL pointing to the image that is to be analyzed.}
@returns(202) The service has accepted the request and will start processing later.

@endpoint GET /read/operations/{operationId}
@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.
@required {operationId: any # Id of read operation returned in the response of the 'Batch Read File' interface.}
@returns(200) Returns the read operation status.

@endgroup

@end