CustomVisionTrainingClientExtensions.GetTaggedImagesAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training

Assembly:

Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.dll

Package:

Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training v2.0.0

Source:

CustomVisionTrainingClientExtensions.cs

Get tagged images for a given project iteration.

public static System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.Image>> GetTaggedImagesAsync (this Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.ICustomVisionTrainingClient operations, Guid projectId, Guid? iterationId = default, System.Collections.Generic.IList<Guid> tagIds = default, string orderBy = default, int? take = 50, int? skip = 0, System.Threading.CancellationToken cancellationToken = default);

static member GetTaggedImagesAsync : Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.ICustomVisionTrainingClient * Guid * Nullable<Guid> * System.Collections.Generic.IList<Guid> * string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.Image>>

<Extension()>
Public Function GetTaggedImagesAsync (operations As ICustomVisionTrainingClient, projectId As Guid, Optional iterationId As Nullable(Of Guid) = Nothing, Optional tagIds As IList(Of Guid) = Nothing, Optional orderBy As String = Nothing, Optional take As Nullable(Of Integer) = 50, Optional skip As Nullable(Of Integer) = 0, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of Image))

Parameters

operations

ICustomVisionTrainingClient

The operations group for this extension method.

projectId

Guid

The project id.

iterationId

Nullable<Guid>

The iteration id. Defaults to workspace.

tagIds

IList<Guid>

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

orderBy

String

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

take

Nullable<Int32>

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

skip

Nullable<Int32>

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

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<IList<Image>>

Remarks

This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned