Custom Vision

Azure Custom Vision Service is a Microsoft Cognitive Services product for tagging images using your custom computer vision model.

Status: Preview

Tier: Standard

Version: 1.0.0

Actions:

Name	Summary
PredictImageURL (string projectId, [Optional]string iterationId, PredictImageURL_Request body, [internal]string Content-Type)	Predict tags from image URL
PredictImage (string projectId, [Optional]string iterationId, [internal]string Content-Type, string Image)	Predict tags from image
ClassifyImageUrl (string projectId, string publishedName, PredictImageURL_Request body, [internal]string Content-Type)	Classify an image url
ClassifyImage (string projectId, string publishedName, [internal]string Content-Type, string Image)	Classify an image
DetectImageUrl (string projectId, string publishedName, PredictImageURL_Request body, [internal]string Content-Type)	Detect objects in an image url
DetectImage (string projectId, string publishedName, [internal]string Content-Type, string Image)	Detect objects in an image
ClassifyImageUrlV2 (string projectId, string publishedName, PredictImageURL_Request body)	Classify an image url (V2)
ClassifyImageV2 (string projectId, string publishedName, string Image)	Classify an image (V2)
DetectImageUrlV2 (string projectId, string publishedName, PredictImageURL_Request body)	Detect objects in an image url (V2)
DetectImageV2 (string projectId, string publishedName, string Image)	Detect objects in an image (V2)

Triggers:

Name

Summary

Objects:

Name	Summary
PredictImageURL_Request
PredictImageURL_Response
PredictImage_ResponseV2
PredictImage_ResponseV3

Actions:

PredictImageURL

Summary: Predict tags from image URL

Description: Predict the tags for an image located at the specified URL.

Syntax:

CustomVision.PredictImageURL (string projectId, [Optional]string iterationId, PredictImageURL_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
iterationId	string (Iteration ID)	The id of a particular iteration to evaluate against. The default iteration for the project will be used when not specified.	False
body	PredictImageURL_Request		True
Content-Type	string (Content-Type)		True

Returns:

Type:PredictImageURL_Response

PredictImage

Summary: Predict tags from image

Description: Predict the tags for an image based on image content.

Syntax:

CustomVision.PredictImage (string projectId, [Optional]string iterationId, [internal]string Content-Type, string Image)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
iterationId	string (Iteration ID)	The id of a particular iteration to evaluate against. The default iteration for the project will be used when not specified.	False
Content-Type	string (Content-Type)		True
Image	string(binary)		True

Returns:

Type:PredictImageURL_Response

ClassifyImageUrl

Summary: Classify an image url

Description: Classify an image located at the specified URL.

Syntax:

CustomVision.ClassifyImageUrl (string projectId, string publishedName, PredictImageURL_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
body	PredictImageURL_Request		True
Content-Type	string (Content-Type)		True

Returns:

Type:PredictImage_ResponseV2

ClassifyImage

Summary: Classify an image

Description: Classify an image based on image content.

Syntax:

CustomVision.ClassifyImage (string projectId, string publishedName, [internal]string Content-Type, string Image)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
Content-Type	string (Content-Type)		True
Image	string(binary)		True

Returns:

Type:PredictImage_ResponseV2

DetectImageUrl

Summary: Detect objects in an image url

Description: Detect objects in an image located at the specified URL.

Syntax:

CustomVision.DetectImageUrl (string projectId, string publishedName, PredictImageURL_Request body, [internal]string Content-Type)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
body	PredictImageURL_Request		True
Content-Type	string (Content-Type)		True

Returns:

Type:PredictImage_ResponseV2

DetectImage

Summary: Detect objects in an image

Description: Detect objects in an image based on image content.

Syntax:

CustomVision.DetectImage (string projectId, string publishedName, [internal]string Content-Type, string Image)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
Content-Type	string (Content-Type)		True
Image	string(binary)		True

Returns:

Type:PredictImage_ResponseV2

ClassifyImageUrlV2

Summary: Classify an image url (V2)

Description: Classify an image located at the specified URL (V2).

Syntax:

CustomVision.ClassifyImageUrlV2 (string projectId, string publishedName, PredictImageURL_Request body)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
body	PredictImageURL_Request		True

Returns:

Type:PredictImage_ResponseV3

ClassifyImageV2

Summary: Classify an image (V2)

Description: Classify an image based on image content (V2).

Syntax:

CustomVision.ClassifyImageV2 (string projectId, string publishedName, string Image)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
Image	string(binary)		True

Returns:

Type:PredictImage_ResponseV3

DetectImageUrlV2

Summary: Detect objects in an image url (V2)

Description: Detect objects in an image located at the specified URL (V2).

Syntax:

CustomVision.DetectImageUrlV2 (string projectId, string publishedName, PredictImageURL_Request body)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
body	PredictImageURL_Request		True

Returns:

Type:PredictImage_ResponseV3

DetectImageV2

Summary: Detect objects in an image (V2)

Description: Detect objects in an image based on image content (V2).

Syntax:

CustomVision.DetectImageV2 (string projectId, string publishedName, string Image)

Parameters:

Name	Type	Summary	Required	Related Action
projectId	string (Project ID)	The ID of the Custom Vision Project.	True
publishedName	string (Published Name)	The name of the model to evaluate against.	True
Image	string(binary)		True

Returns:

Type:PredictImage_ResponseV3

PredictImageURL_Request

Summary:

Description:

Properties:

Name

Type

Summary

Url

string

Image URL

The URL of the image to analyze.

PredictImageURL_Response

Summary:

Description:

Properties:

Name	Type	Summary
Created	string(date-time) Created	The date-time the prediction was created.
Id	string Id	The unique identifier of the prediction.
Iteration	string Iteration	The iteration the prediction was evaluated against.
Predictions	array of (PredictionsItem) Predictions	Predictions
Project	string Project	The project the prediction was evaluated against.

PredictionsItem

Summary:

Description:

Properties:

Name	Type	Summary
Probability	number(float) Probability	The probability of the prediction.
Tag	string Tag	The tag from the prediction.
TagId	string TagId	The unique identifier of the tag.

PredictImage_ResponseV2

Summary:

Description:

Properties:

Name	Type	Summary
id	string Id	The unique identifier of the prediction.
project	string Project	The project the prediction was evaluated against.
iteration	string Iteration	The iteration the prediction was evaluated against.
created	string(date-time) Created	The date-time the prediction was created.
Predictions	array of (PredictionsItem) Predictions	Predictions

PredictionsItem

Summary:

Description:

Properties:

Name	Type	Summary
probability	number(float) Probability	The probability of the prediction.
tagName	string Tag	The tag from the prediction.
tagId	string TagId	The unique identifier of the tag.
boundingBox	BoundingBox	The bounding box.

BoundingBox

Summary:

Description: The bounding box.

Properties:

Name	Type	Summary
left	number(float) Left	The x-coordinate of the left-top corner.
top	number(float) Top	The y-coordinate of the left-top corner.
width	number(float) Width	The width of the bounding box.
height	number(float) Height	The height of the bounding box.

PredictImage_ResponseV3

Summary:

Description:

Properties:

Name	Type	Summary
id	string Id	The unique identifier of the prediction.
project	string Project	The project the prediction was evaluated against.
iteration	string Iteration	The iteration the prediction was evaluated against.
created	string(date-time) Created	The date-time the prediction was created.
predictions	array of (PredictionsItem) Predictions	Predictions

PredictionsItem

Summary:

Description:

Properties:

Name	Type	Summary
probability	number(float) Probability	The probability of the prediction.
tagName	string Tag	The tag from the prediction.
tagId	string TagId	The unique identifier of the tag.
boundingBox	BoundingBox	The bounding box.

BoundingBox

Summary:

Description: The bounding box.

Properties:

Name	Type	Summary
left	number(float) Left	The x-coordinate of the left-top corner.
top	number(float) Top	The y-coordinate of the left-top corner.
width	number(float) Width	The width of the bounding box.
height	number(float) Height	The height of the bounding box.