ImageModerationExtensions.OCRFileInputAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.ContentModerator

Assembly:

Microsoft.Azure.CognitiveServices.ContentModerator.dll

Package:

Microsoft.Azure.CognitiveServices.ContentModerator v2.0.0

Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.ContentModerator.Models.OCR> OCRFileInputAsync (this Microsoft.Azure.CognitiveServices.ContentModerator.IImageModeration operations, string language, System.IO.Stream imageStream, bool? cacheImage = default, bool? enhanced = False, System.Threading.CancellationToken cancellationToken = default);

static member OCRFileInputAsync : Microsoft.Azure.CognitiveServices.ContentModerator.IImageModeration * string * System.IO.Stream * Nullable<bool> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.ContentModerator.Models.OCR>

<Extension()>
Public Function OCRFileInputAsync (operations As IImageModeration, language As String, imageStream As Stream, Optional cacheImage As Nullable(Of Boolean) = Nothing, Optional enhanced As Nullable(Of Boolean) = False, Optional cancellationToken As CancellationToken = Nothing) As Task(Of OCR)

Parameters

operations

IImageModeration

The operations group for this extension method.

language

String

Language of the terms.

imageStream

Stream

The image file.

cacheImage

Nullable<Boolean>

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

enhanced

Nullable<Boolean>

When set to True, the image goes through additional processing to come with additional candidates.

image/tiff is not supported when enhanced is set to true

Note: This impacts the response time.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<OCR>