你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

TrainingAPIClientGetImagesOptionalParams interface

包:

@azure/cognitiveservices-customvision-training

可选参数。

Extends

RequestOptionsBase

属性

filter	一个表达式，用于根据图像元数据筛选图像。 只有表达式计算结果为 true 的图像才会包含在响应中。 表达式支持 eq (Equal) 、ne (Not equal) 、 (Logical 和) 或 (Logical 或) 运算符。 下面是一个示例，metadata=key1 eq 'value1' 和 key2 ne 'value2'。
iterationId	迭代 ID。默认为工作区。
orderBy	排序。 默认为最新。 可能的值包括：“Newest”、“Oldest”
skip	在开始映像批处理之前要跳过的图像数。 默认值为 0。 默认值：0。
taggingStatus	标记状态筛选器。 它可以是“All”、“Tagged”或“Untagged”。 默认为“All”。 可能的值包括：“All”、“Tagged”、“Untagged”
tagIds	用于筛选图像的标记 ID 列表。 当为 null 时，默认为所有标记的图像。 限制为 20。
take	要返回的最大图像数。 默认值为 50，限制为 256。 默认值：50。

继承属性

abortSignal	可用于中止请求的信号。
customHeaders	用户定义的自定义请求标头，将在发送请求之前应用这些标头。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可以花费的毫秒数。

属性详细信息

filter

一个表达式，用于根据图像元数据筛选图像。 只有表达式计算结果为 true 的图像才会包含在响应中。 表达式支持 eq (Equal) 、ne (Not equal) 、 (Logical 和) 或 (Logical 或) 运算符。 下面是一个示例，metadata=key1 eq 'value1' 和 key2 ne 'value2'。

filter?: string

属性值

string

iterationId

迭代 ID。默认为工作区。

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

用于筛选图像的标记 ID 列表。 当为 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