ImageModerationExtensions.MatchFileInputAsync Method

Definition

Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using <a href="/docs/services/578ff44d2703741568569ab9/operations/578ff7b12703741568569abe">this</a> API.

Returns ID and tags of matching image.<br/> <br/> Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.ContentModerator.Models.MatchResponse> MatchFileInputAsync (this Microsoft.Azure.CognitiveServices.ContentModerator.IImageModeration operations, System.IO.Stream imageStream, string listId = default, bool? cacheImage = default, System.Threading.CancellationToken cancellationToken = default);
static member MatchFileInputAsync : Microsoft.Azure.CognitiveServices.ContentModerator.IImageModeration * System.IO.Stream * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.ContentModerator.Models.MatchResponse>
<Extension()>
Public Function MatchFileInputAsync (operations As IImageModeration, imageStream As Stream, Optional listId As String = Nothing, Optional cacheImage As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of MatchResponse)

Parameters

operations
IImageModeration

The operations group for this extension method.

imageStream
Stream

The image file.

listId
String

The list Id.

cacheImage
Nullable<Boolean>

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

cancellationToken
CancellationToken

The cancellation token.

Returns

Applies to