Microsoft Cognitiveservices Prediction is a Microsoft Cognitive Services API for using trained machine learning models to make predictions from input data.

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 Prediction

Microsoft Cognitiveservices Prediction is a Microsoft Cognitive Services API for using trained machine learning models to make predictions from input data.

Base URL: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.0/prediction
Auth: header:Prediction-Key (pass your key via the apiKey input)

Operations

classifyimage — POST /{projectId}/classify/iterations/{publishedName}/image — Classify an image and saves the result.
classifyimagewithnostore — POST /{projectId}/classify/iterations/{publishedName}/image/nostore — Classify an image without saving the result.
classifyimageurl — POST /{projectId}/classify/iterations/{publishedName}/url — Classify an image url and saves the result.
classifyimageurlwithnostore — POST /{projectId}/classify/iterations/{publishedName}/url/nostore — Classify an image url without saving the result.
detectimage — POST /{projectId}/detect/iterations/{publishedName}/image — Detect objects in an image and saves the result.
detectimagewithnostore — POST /{projectId}/detect/iterations/{publishedName}/image/nostore — Detect objects in an image without saving the result.

Inputs

apiKey — your microsoft-cognitiveservices-prediction API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: classifyimage
apiKey: <your key>

Publishes

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: classifyimage, classifyimagewithnostore, classifyimageurl, classifyimageurlwithnostore, detectimage, detectimagewithnostore
`projectId`	string	no	—	Path parameter projectId (required by some operations).
`publishedName`	string	no	—	Path parameter publishedName (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.
`body`	string	no	—	Request body as a JSON object string (for create/update operations).