ImageModeration.FindFacesWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.ContentModerator

Assembly:

Microsoft.Azure.CognitiveServices.ContentModerator.dll

Package:

Microsoft.Azure.CognitiveServices.ContentModerator v2.0.0

Returns the list of faces found.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.FoundFaces>> FindFacesWithHttpMessagesAsync (bool? cacheImage = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member FindFacesWithHttpMessagesAsync : Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.FoundFaces>>
override this.FindFacesWithHttpMessagesAsync : Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.FoundFaces>>

Public Function FindFacesWithHttpMessagesAsync (Optional cacheImage As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of FoundFaces))

Parameters

cacheImage

Nullable<Boolean>

Whether to retain the submitted image for future use; defaults to false if omitted.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<FoundFaces>>

Implements

FindFacesWithHttpMessagesAsync(Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

APIErrorException

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