TrainingAPIClientGetImagesOptionalParams interface

Package:

@azure/cognitiveservices-customvision-training

Optional Parameters.

Extends

RequestOptionsBase

Properties

filter	An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response. The expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators. Here is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.
iterationId	The iteration id. Defaults to workspace.
orderBy	The ordering. Defaults to newest. Possible values include: 'Newest', 'Oldest'
skip	Number of images to skip before beginning the image batch. Defaults to 0. Default value: 0.
taggingStatus	The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'. Possible values include: 'All', 'Tagged', 'Untagged'
tagIds	A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
take	Maximum number of images to return. Defaults to 50, limited to 256. Default value: 50.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

filter

An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response. The expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators. Here is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.

filter?: string

Property Value

string

iterationId

The iteration id. Defaults to workspace.

iterationId?: string

Property Value

string

orderBy

The ordering. Defaults to newest. Possible values include: 'Newest', 'Oldest'

orderBy?: OrderBy1

Property Value

OrderBy1

skip

Number of images to skip before beginning the image batch. Defaults to 0. Default value: 0.

skip?: number

Property Value

number

taggingStatus

The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'. Possible values include: 'All', 'Tagged', 'Untagged'

taggingStatus?: TaggingStatus

Property Value

TaggingStatus

tagIds

A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.

tagIds?: string[]

Property Value

string[]

take

Maximum number of images to return. Defaults to 50, limited to 256. Default value: 50.

take?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout