CustomVisionTrainingClient.GetImageRegionProposalsWithHttpMessagesAsync 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:

CustomVisionTrainingClient.cs

Get region proposals for an image. Returns empty array if no proposals are found.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.ImageRegionProposal>> GetImageRegionProposalsWithHttpMessagesAsync (Guid projectId, Guid imageId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetImageRegionProposalsWithHttpMessagesAsync : Guid * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.ImageRegionProposal>>
override this.GetImageRegionProposalsWithHttpMessagesAsync : Guid * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training.Models.ImageRegionProposal>>

Public Function GetImageRegionProposalsWithHttpMessagesAsync (projectId As Guid, imageId As Guid, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of ImageRegionProposal))

Parameters

projectId

Guid

The project id.

imageId

Guid

The image id.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<ImageRegionProposal>>

Implements

GetImageRegionProposalsWithHttpMessagesAsync(Guid, Guid, Dictionary<String,List<String>>, CancellationToken)

Exceptions

CustomVisionErrorException

Thrown when the operation returned an invalid status code

HttpOperationException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.