TrainingAPIClientGetImagesOptionalParams interface
Необязательные параметры.
- Extends
Свойства
filter | Выражение для фильтрации изображений по метаданным изображения. В ответ включаются только изображения, в которых выражение имеет значение true. Выражение поддерживает операторы eq (Equal), ne (Not equal) и (Логические и) или (Логические или) операторы. Ниже приведен пример метаданных=key1 eq "value1" и key2 ne "value2". |
iteration |
Идентификатор итерации. По умолчанию используется рабочая область. |
order |
Порядок. По умолчанию используется новейшая версия. Возможные значения: "Newest", "Старый" |
skip | Количество образов, которые следует пропустить перед началом пакета образов. Значение по умолчанию — 0. Значение по умолчанию: 0. |
tagging |
Фильтр состояния тегов. Это может быть "All", "Tagged" или "Untagged". По умолчанию используется значение All. Возможные значения: "All", "Tagged", "Untagged" |
tag |
Список идентификаторов тегов для фильтрации изображений. По умолчанию для всех помеченных изображений используется значение NULL. Ограничено 20. |
take | Максимальное количество возвращаемых изображений. Значение по умолчанию — 50, ограничено 256. Значение по умолчанию: 50. |
Унаследованные свойства
abort |
Сигнал, который можно использовать для прерывания запросов. |
custom |
Пользовательские заголовки запросов, которые будут применены перед отправкой запроса. |
on |
Обратный вызов, который запускается при выполнении скачивания. |
on |
Обратный вызов, который запускается при выполнении отправки. |
timeout | Число миллисекундах запроса может приниматься перед автоматическим завершением. |
Сведения о свойстве
filter
Выражение для фильтрации изображений по метаданным изображения. В ответ включаются только изображения, в которых выражение имеет значение true. Выражение поддерживает операторы eq (Equal), ne (Not equal) и (Логические и) или (Логические или) операторы. Ниже приведен пример метаданных=key1 eq "value1" и key2 ne "value2".
filter?: string
Значение свойства
string
iterationId
Идентификатор итерации. По умолчанию используется рабочая область.
iterationId?: string
Значение свойства
string
orderBy
Порядок. По умолчанию используется новейшая версия. Возможные значения: "Newest", "Старый"
orderBy?: OrderBy1
Значение свойства
skip
Количество образов, которые следует пропустить перед началом пакета образов. Значение по умолчанию — 0. Значение по умолчанию: 0.
skip?: number
Значение свойства
number
taggingStatus
Фильтр состояния тегов. Это может быть "All", "Tagged" или "Untagged". По умолчанию используется значение All. Возможные значения: "All", "Tagged", "Untagged"
taggingStatus?: TaggingStatus
Значение свойства
tagIds
Список идентификаторов тегов для фильтрации изображений. По умолчанию для всех помеченных изображений используется значение NULL. Ограничено 20.
tagIds?: string[]
Значение свойства
string[]
take
Максимальное количество возвращаемых изображений. Значение по умолчанию — 50, ограничено 256. Значение по умолчанию: 50.
take?: number
Значение свойства
number
Сведения об унаследованном свойстве
abortSignal
Сигнал, который можно использовать для прерывания запросов.
abortSignal?: 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