ImageModerations Interface

Package:

com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface ImageModerations

An instance of this class provides access to all the operations defined in ImageModerations.

Method Summary

Modifier and Type	Method and Description
ImageModerationsEvaluateFileInputDefinitionStages.WithImageStream	evaluateFileInput() Returns probabilities of the image containing racy or adult content.
Evaluate	evaluateFileInput(byte[] imageStream, EvaluateFileInputOptionalParameter evaluateFileInputOptionalParameter) Returns probabilities of the image containing racy or adult content.
Observable<Evaluate>	evaluateFileInputAsync(byte[] imageStream, EvaluateFileInputOptionalParameter evaluateFileInputOptionalParameter) Returns probabilities of the image containing racy or adult content.
ImageModerationsEvaluateMethodDefinitionStages.WithExecute	evaluateMethod() Returns probabilities of the image containing racy or adult content.
Evaluate	evaluateMethod(EvaluateMethodOptionalParameter evaluateMethodOptionalParameter) Returns probabilities of the image containing racy or adult content.
Observable<Evaluate>	evaluateMethodAsync(EvaluateMethodOptionalParameter evaluateMethodOptionalParameter) Returns probabilities of the image containing racy or adult content.
ImageModerationsEvaluateUrlInputDefinitionStages.WithContentType	evaluateUrlInput() Returns probabilities of the image containing racy or adult content.
Evaluate	evaluateUrlInput(String contentType, BodyModelModel imageUrl, EvaluateUrlInputOptionalParameter evaluateUrlInputOptionalParameter) Returns probabilities of the image containing racy or adult content.
Observable<Evaluate>	evaluateUrlInputAsync(String contentType, BodyModelModel imageUrl, EvaluateUrlInputOptionalParameter evaluateUrlInputOptionalParameter) Returns probabilities of the image containing racy or adult content.
ImageModerationsFindFacesDefinitionStages.WithExecute	findFaces() Returns the list of faces found.
FoundFaces	findFaces(FindFacesOptionalParameter findFacesOptionalParameter) Returns the list of faces found.
Observable<FoundFaces>	findFacesAsync(FindFacesOptionalParameter findFacesOptionalParameter) Returns the list of faces found.
ImageModerationsFindFacesFileInputDefinitionStages.WithImageStream	findFacesFileInput() Returns the list of faces found.
FoundFaces	findFacesFileInput(byte[] imageStream, FindFacesFileInputOptionalParameter findFacesFileInputOptionalParameter) Returns the list of faces found.
Observable<FoundFaces>	findFacesFileInputAsync(byte[] imageStream, FindFacesFileInputOptionalParameter findFacesFileInputOptionalParameter) Returns the list of faces found.
ImageModerationsFindFacesUrlInputDefinitionStages.WithContentType	findFacesUrlInput() Returns the list of faces found.
FoundFaces	findFacesUrlInput(String contentType, BodyModelModel imageUrl, FindFacesUrlInputOptionalParameter findFacesUrlInputOptionalParameter) Returns the list of faces found.
Observable<FoundFaces>	findFacesUrlInputAsync(String contentType, BodyModelModel imageUrl, FindFacesUrlInputOptionalParameter findFacesUrlInputOptionalParameter) Returns the list of faces found.
ImageModerationsMatchFileInputDefinitionStages.WithImageStream	matchFileInput() 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.
MatchResponse	matchFileInput(byte[] imageStream, MatchFileInputOptionalParameter matchFileInputOptionalParameter) 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.
Observable<MatchResponse>	matchFileInputAsync(byte[] imageStream, MatchFileInputOptionalParameter matchFileInputOptionalParameter) 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.
ImageModerationsMatchMethodDefinitionStages.WithExecute	matchMethod() 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.
MatchResponse	matchMethod(MatchMethodOptionalParameter matchMethodOptionalParameter) 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.
Observable<MatchResponse>	matchMethodAsync(MatchMethodOptionalParameter matchMethodOptionalParameter) 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.
ImageModerationsMatchUrlInputDefinitionStages.WithContentType	matchUrlInput() 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.
MatchResponse	matchUrlInput(String contentType, BodyModelModel imageUrl, MatchUrlInputOptionalParameter matchUrlInputOptionalParameter) 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.
Observable<MatchResponse>	matchUrlInputAsync(String contentType, BodyModelModel imageUrl, MatchUrlInputOptionalParameter matchUrlInputOptionalParameter) 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.
ImageModerationsOCRFileInputDefinitionStages.WithLanguage	oCRFileInput() Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
OCR	oCRFileInput(String language, byte[] imageStream, OCRFileInputOptionalParameter oCRFileInputOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
Observable<OCR>	oCRFileInputAsync(String language, byte[] imageStream, OCRFileInputOptionalParameter oCRFileInputOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
ImageModerationsOCRMethodDefinitionStages.WithLanguage	oCRMethod() Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
OCR	oCRMethod(String language, OCRMethodOptionalParameter oCRMethodOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
Observable<OCR>	oCRMethodAsync(String language, OCRMethodOptionalParameter oCRMethodOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
ImageModerationsOCRUrlInputDefinitionStages.WithLanguage	oCRUrlInput() Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
OCR	oCRUrlInput(String language, String contentType, BodyModelModel imageUrl, OCRUrlInputOptionalParameter oCRUrlInputOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
Observable<OCR>	oCRUrlInputAsync(String language, String contentType, BodyModelModel imageUrl, OCRUrlInputOptionalParameter oCRUrlInputOptionalParameter) Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.

Method Details

evaluateFileInput

public ImageModerationsEvaluateFileInputDefinitionStages.WithImageStream evaluateFileInput()

Returns probabilities of the image containing racy or adult content.

Returns:

the first stage of the evaluateFileInput call

evaluateFileInput

public Evaluate evaluateFileInput(byte[] imageStream, EvaluateFileInputOptionalParameter evaluateFileInputOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

imageStream - The image file.

evaluateFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the Evaluate object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

evaluateFileInputAsync

public Observable evaluateFileInputAsync(byte[] imageStream, EvaluateFileInputOptionalParameter evaluateFileInputOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

imageStream - The image file.

evaluateFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Evaluate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateMethod

public ImageModerationsEvaluateMethodDefinitionStages.WithExecute evaluateMethod()

Returns probabilities of the image containing racy or adult content.

Returns:

the first stage of the evaluateMethod call

evaluateMethod

public Evaluate evaluateMethod(EvaluateMethodOptionalParameter evaluateMethodOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

evaluateMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the Evaluate object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

evaluateMethodAsync

public Observable evaluateMethodAsync(EvaluateMethodOptionalParameter evaluateMethodOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

evaluateMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Evaluate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateUrlInput

public ImageModerationsEvaluateUrlInputDefinitionStages.WithContentType evaluateUrlInput()

Returns probabilities of the image containing racy or adult content.

Returns:

the first stage of the evaluateUrlInput call

evaluateUrlInput

public Evaluate evaluateUrlInput(String contentType, BodyModelModel imageUrl, EvaluateUrlInputOptionalParameter evaluateUrlInputOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

contentType - The content type.

imageUrl - The image url.

evaluateUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the Evaluate object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

evaluateUrlInputAsync

public Observable evaluateUrlInputAsync(String contentType, BodyModelModel imageUrl, EvaluateUrlInputOptionalParameter evaluateUrlInputOptionalParameter)

Returns probabilities of the image containing racy or adult content.

Parameters:

contentType - The content type.

imageUrl - The image url.

evaluateUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Evaluate object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

findFaces

public ImageModerationsFindFacesDefinitionStages.WithExecute findFaces()

Returns the list of faces found.

Returns:

the first stage of the findFaces call

findFaces

public FoundFaces findFaces(FindFacesOptionalParameter findFacesOptionalParameter)

Returns the list of faces found.

Parameters:

findFacesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the FoundFaces object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

findFacesAsync

public Observable findFacesAsync(FindFacesOptionalParameter findFacesOptionalParameter)

Returns the list of faces found.

Parameters:

findFacesOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the FoundFaces object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

findFacesFileInput

public ImageModerationsFindFacesFileInputDefinitionStages.WithImageStream findFacesFileInput()

Returns the list of faces found.

Returns:

the first stage of the findFacesFileInput call

findFacesFileInput

public FoundFaces findFacesFileInput(byte[] imageStream, FindFacesFileInputOptionalParameter findFacesFileInputOptionalParameter)

Returns the list of faces found.

Parameters:

imageStream - The image file.

findFacesFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the FoundFaces object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

findFacesFileInputAsync

public Observable findFacesFileInputAsync(byte[] imageStream, FindFacesFileInputOptionalParameter findFacesFileInputOptionalParameter)

Returns the list of faces found.

Parameters:

imageStream - The image file.

findFacesFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the FoundFaces object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

findFacesUrlInput

public ImageModerationsFindFacesUrlInputDefinitionStages.WithContentType findFacesUrlInput()

Returns the list of faces found.

Returns:

the first stage of the findFacesUrlInput call

findFacesUrlInput

public FoundFaces findFacesUrlInput(String contentType, BodyModelModel imageUrl, FindFacesUrlInputOptionalParameter findFacesUrlInputOptionalParameter)

Returns the list of faces found.

Parameters:

contentType - The content type.

imageUrl - The image url.

findFacesUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the FoundFaces object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

findFacesUrlInputAsync

public Observable findFacesUrlInputAsync(String contentType, BodyModelModel imageUrl, FindFacesUrlInputOptionalParameter findFacesUrlInputOptionalParameter)

Returns the list of faces found.

Parameters:

contentType - The content type.

imageUrl - The image url.

findFacesUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the FoundFaces object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

matchFileInput

public ImageModerationsMatchFileInputDefinitionStages.WithImageStream matchFileInput()

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.

Returns:

the first stage of the matchFileInput call

matchFileInput

public MatchResponse matchFileInput(byte[] imageStream, MatchFileInputOptionalParameter matchFileInputOptionalParameter)

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.

Parameters:

imageStream - The image file.

matchFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the MatchResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

matchFileInputAsync

public Observable matchFileInputAsync(byte[] imageStream, MatchFileInputOptionalParameter matchFileInputOptionalParameter)

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.

Parameters:

imageStream - The image file.

matchFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the MatchResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

matchMethod

public ImageModerationsMatchMethodDefinitionStages.WithExecute matchMethod()

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.

Returns:

the first stage of the matchMethod call

matchMethod

public MatchResponse matchMethod(MatchMethodOptionalParameter matchMethodOptionalParameter)

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.

Parameters:

matchMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the MatchResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

matchMethodAsync

public Observable matchMethodAsync(MatchMethodOptionalParameter matchMethodOptionalParameter)

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.

Parameters:

matchMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the MatchResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

matchUrlInput

public ImageModerationsMatchUrlInputDefinitionStages.WithContentType matchUrlInput()

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.

Returns:

the first stage of the matchUrlInput call

matchUrlInput

public MatchResponse matchUrlInput(String contentType, BodyModelModel imageUrl, MatchUrlInputOptionalParameter matchUrlInputOptionalParameter)

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.

Parameters:

contentType - The content type.

imageUrl - The image url.

matchUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the MatchResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

matchUrlInputAsync

public Observable matchUrlInputAsync(String contentType, BodyModelModel imageUrl, MatchUrlInputOptionalParameter matchUrlInputOptionalParameter)

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.

Parameters:

contentType - The content type.

imageUrl - The image url.

matchUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the MatchResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

oCRFileInput

public ImageModerationsOCRFileInputDefinitionStages.WithLanguage oCRFileInput()

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

Returns:

the first stage of the oCRFileInput call

oCRFileInput

public OCR oCRFileInput(String language, byte[] imageStream, OCRFileInputOptionalParameter oCRFileInputOptionalParameter)

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

Parameters:

language - Language of the terms.

imageStream - The image file.

oCRFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OCR object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

oCRFileInputAsync

public Observable oCRFileInputAsync(String language, byte[] imageStream, OCRFileInputOptionalParameter oCRFileInputOptionalParameter)

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

Parameters:

language - Language of the terms.

imageStream - The image file.

oCRFileInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OCR object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

oCRMethod

public ImageModerationsOCRMethodDefinitionStages.WithLanguage oCRMethod()

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

Returns:

the first stage of the oCRMethod call

oCRMethod

public OCR oCRMethod(String language, OCRMethodOptionalParameter oCRMethodOptionalParameter)

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

Parameters:

language - Language of the terms.

oCRMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OCR object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

oCRMethodAsync

public Observable oCRMethodAsync(String language, OCRMethodOptionalParameter oCRMethodOptionalParameter)

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

Parameters:

language - Language of the terms.

oCRMethodOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OCR object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

oCRUrlInput

public ImageModerationsOCRUrlInputDefinitionStages.WithLanguage oCRUrlInput()

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

Returns:

the first stage of the oCRUrlInput call

oCRUrlInput

public OCR oCRUrlInput(String language, String contentType, BodyModelModel imageUrl, OCRUrlInputOptionalParameter oCRUrlInputOptionalParameter)

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

Parameters:

language - Language of the terms.

contentType - The content type.

imageUrl - The image url.

oCRUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OCR object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

oCRUrlInputAsync

public Observable oCRUrlInputAsync(String language, String contentType, BodyModelModel imageUrl, OCRUrlInputOptionalParameter oCRUrlInputOptionalParameter)

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

Parameters:

language - Language of the terms.

contentType - The content type.

imageUrl - The image url.

oCRUrlInputOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OCR object

Throws:

IllegalArgumentException - thrown if parameters fail the validation