TrainingAPIClientGetImagesOptionalParams interface

套件:

@azure/cognitiveservices-customvision-training

選擇性參數。

Extends

RequestOptionsBase

屬性

filter	針對影像元數據篩選影像的表達式。 只有表達式評估為 true 的影像才會包含在回應中。 表達式支援 eq （Equal）、ne （Not equal） 和 （Logical and）， 或 （Logical or） 運算符。 以下是 metadata=key1 eq 'value1' 和 key2 ne 'value2' 的範例。
iterationId	反覆項目標識碼。默認為工作區。
orderBy	排序。 預設為最新。 可能的值包括：'Newest'、'Oldest'
skip	開始映像批次之前要略過的映射數目。 預設值為 0。 預設值：0。
taggingStatus	標記狀態篩選條件。 它可以是 『All』、『Tagged』或 『Untagged』。 預設為 『All』。 可能的值包括：'All'、'Tagged'、'Untagged'
tagIds	用來篩選影像的標記標識碼清單。 當 Null 時，預設為所有標記的影像。 限制為 20。
take	要傳回的影像數目上限。 默認值為 50，限制為 256。 默認值：50。

繼承的屬性

abortSignal	可用來中止要求的訊號。
customHeaders	使用者定義自定義要求標頭，將在傳送要求之前套用。
onDownloadProgress	下載進度引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
timeout	要求在自動終止之前可能需要的毫秒數。

屬性詳細資料

filter

針對影像元數據篩選影像的表達式。 只有表達式評估為 true 的影像才會包含在回應中。 表達式支援 eq （Equal）、ne （Not equal） 和 （Logical and）， 或 （Logical or） 運算符。 以下是 metadata=key1 eq 'value1' 和 key2 ne 'value2' 的範例。

filter?: string

屬性值

string

iterationId

反覆項目標識碼。默認為工作區。

iterationId?: string

屬性值

string

orderBy

排序。 預設為最新。 可能的值包括：'Newest'、'Oldest'

orderBy?: OrderBy1

屬性值

OrderBy1

skip

開始映像批次之前要略過的映射數目。 預設值為 0。 預設值：0。

skip?: number

屬性值

number

taggingStatus

標記狀態篩選條件。 它可以是 『All』、『Tagged』或 『Untagged』。 預設為 『All』。 可能的值包括：'All'、'Tagged'、'Untagged'

taggingStatus?: TaggingStatus

屬性值

TaggingStatus

tagIds

用來篩選影像的標記標識碼清單。 當 Null 時，預設為所有標記的影像。 限制為 20。

tagIds?: string[]

屬性值

string[]

take

要傳回的影像數目上限。 默認值為 50，限制為 256。 默認值：50。

take?: number

屬性值

number

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承自 msRest.RequestOptionsBase.abortSignal

customHeaders

使用者定義自定義要求標頭，將在傳送要求之前套用。

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

屬性值

{[key: string]: string}

繼承自 msRest.RequestOptionsBase.customHeaders

onDownloadProgress

下載進度引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 msRest.RequestOptionsBase.onUploadProgress

timeout

要求在自動終止之前可能需要的毫秒數。

timeout?: number

屬性值

number

繼承自 msRest.RequestOptionsBase.timeout