Microsoft Cognitiveservices Ocr is a Microsoft Cognitive Services API for detecting and extracting printed or handwritten text from images and documents.
Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.
Microsoft Cognitiveservices Ocr is a Microsoft Cognitive Services API for detecting and extracting printed or handwritten text from images and documents.
Base URL: https://westcentralus.api.cognitive.microsoft.com/vision/v2.1
Auth: header:Ocp-Apim-Subscription-Key (pass your key via the apiKey input)
Operations
getreadoperationresult — GET /read/operations/{operationId} — This interface is used for getting OCR results of Read operation. The URL to thi
gettextoperationresult — GET /textOperations/{operationId} — This interface is used for getting text operation result. The URL to this interf
batchreadfile — POST /read/core/asyncBatchAnalyze — Use this interface to get the result of a Read operation, employing the state-of
recognizetext — POST /recognizeText — Recognize Text operation. When you use the Recognize Text interface, the respons
Inputs
apiKey — your microsoft-cognitiveservices-ocr API key
operation — one of the operations above
path parameters when an operation's path contains {...}
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
error
operation
result
status
Input Properties
Every property this tool accepts, from its own tool.iml.
Property
Type
Required
Default
Description
apiKey
string
yes
—
DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
operation
string
yes
—
One of: getreadoperationresult, gettextoperationresult, batchreadfile, recognizetext
operationId
string
no
—
Path parameter operationId (required by some operations).
body
string
no
—
Request body as a JSON object string (for create/update operations).
query
string
no
—
Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.