Share via


CustomVisionTrainingClient.GetImagesByIdsWithHttpMessagesAsync Method

Definition

Get images by id for a given project iteration.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.Image>>> GetImagesByIdsWithHttpMessagesAsync (Guid projectId, System.Collections.Generic.IList<Guid> imageIds = default, Guid? iterationId = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetImagesByIdsWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * Nullable<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.Image>>>
override this.GetImagesByIdsWithHttpMessagesAsync : Guid * System.Collections.Generic.IList<Guid> * Nullable<Guid> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.Image>>>
Public Function GetImagesByIdsWithHttpMessagesAsync (projectId As Guid, Optional imageIds As IList(Of Guid) = Nothing, Optional iterationId As Nullable(Of Guid) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of Image)))

Parameters

projectId
Guid

The project id.

imageIds
IList<Guid>

The list of image ids to retrieve. Limited to 256.

iterationId
Nullable<Guid>

The iteration id. Defaults to workspace.

customHeaders
Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Implements

Exceptions

Thrown when the operation returned an invalid status code

Thrown when unable to deserialize the response

Thrown when a required parameter is null

Thrown when a required parameter is null

Remarks

This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.

Applies to