Image interface

Package:

@azure/cognitiveservices-customvision-training

Image model to be sent as JSON.

Properties

created	Date the image was created. NOTE: This property will not be serialized. It can only be populated by the server.
height	Height of the image. NOTE: This property will not be serialized. It can only be populated by the server.
id	Id of the image. NOTE: This property will not be serialized. It can only be populated by the server.
metadata	Metadata associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.
originalImageUri	The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.
regions	Regions associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.
resizedImageUri	The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Tags associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUri	The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.
width	Width of the image. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

created

Date the image was created. NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

height

Height of the image. NOTE: This property will not be serialized. It can only be populated by the server.

height?: number

Property Value

number

id

Id of the image. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

metadata

Metadata associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

originalImageUri

The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

originalImageUri?: string

Property Value

string

regions

Regions associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.

regions?: ImageRegion[]

Property Value

ImageRegion[]

resizedImageUri

The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

resizedImageUri?: string

Property Value

string

tags

Tags associated with this image. NOTE: This property will not be serialized. It can only be populated by the server.

tags?: ImageTag[]

Property Value

ImageTag[]

thumbnailUri

The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnailUri?: string

Property Value

string

width

Width of the image. NOTE: This property will not be serialized. It can only be populated by the server.

width?: number

Property Value

number