IImageModeration.OCRFileInputWithHttpMessagesAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.OCR>> OCRFileInputWithHttpMessagesAsync (string language, System.IO.Stream imageStream, bool? cacheImage = default, bool? enhanced = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member OCRFileInputWithHttpMessagesAsync : string * System.IO.Stream * Nullable<bool> * 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.OCR>>
Public Function OCRFileInputWithHttpMessagesAsync (language As String, imageStream As Stream, Optional cacheImage As Nullable(Of Boolean) = Nothing, Optional enhanced As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of OCR))
Parameters
- language
- String
Language of the terms.
- imageStream
- Stream
The image file.
Whether to retain the submitted image for future use; defaults to false if omitted.
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.
- customHeaders
- Dictionary<String,List<String>>
The headers that will be added to request.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Exceptions
Thrown when the operation returned an invalid status code
Thrown when unable to deserialize the response
Thrown when a required parameter is null
Applies to
Azure SDK for .NET