ComputerVisionImpl Class

  • java.lang.Object
    • com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl

Implements

public class ComputerVisionImpl
implements ComputerVision

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

Constructor Summary

Constructor Description
ComputerVisionImpl(Retrofit retrofit, ComputerVisionClientImpl client)

Initializes an instance of ComputerVisionImpl.

Method Summary

Modifier and Type Method and Description
com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionAnalyzeImageParameters analyzeImage()

This operation extracts a rich set of visual features based on the image content.

ImageAnalysis analyzeImage(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<ImageAnalysis> analyzeImageAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

com.microsoft.rest.ServiceFuture<ImageAnalysis> analyzeImageAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter, ServiceCallback<ImageAnalysis> serviceCallback)

This operation extracts a rich set of visual features based on the image content.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionAnalyzeImageByDomainParameters analyzeImageByDomain()

This operation recognizes content within an image by applying a domain-specific model.

DomainModelResults analyzeImageByDomain(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<DomainModelResults> analyzeImageByDomainAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

com.microsoft.rest.ServiceFuture<DomainModelResults> analyzeImageByDomainAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter, ServiceCallback<DomainModelResults> serviceCallback)

This operation recognizes content within an image by applying a domain-specific model.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionAnalyzeImageByDomainInStreamParameters analyzeImageByDomainInStream()

This operation recognizes content within an image by applying a domain-specific model.

DomainModelResults analyzeImageByDomainInStream(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<DomainModelResults> analyzeImageByDomainInStreamAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

com.microsoft.rest.ServiceFuture<DomainModelResults> analyzeImageByDomainInStreamAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter, ServiceCallback<DomainModelResults> serviceCallback)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<com.microsoft.rest.ServiceResponse<DomainModelResults>> analyzeImageByDomainInStreamWithServiceResponseAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<com.microsoft.rest.ServiceResponse<DomainModelResults>> analyzeImageByDomainInStreamWithServiceResponseAsync(String model, byte[] image, String language, String modelVersion)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<com.microsoft.rest.ServiceResponse<DomainModelResults>> analyzeImageByDomainWithServiceResponseAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model.

rx.Observable<com.microsoft.rest.ServiceResponse<DomainModelResults>> analyzeImageByDomainWithServiceResponseAsync(String model, String url, String language, String modelVersion)

This operation recognizes content within an image by applying a domain-specific model.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionAnalyzeImageInStreamParameters analyzeImageInStream()

This operation extracts a rich set of visual features based on the image content.

ImageAnalysis analyzeImageInStream(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<ImageAnalysis> analyzeImageInStreamAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

com.microsoft.rest.ServiceFuture<ImageAnalysis> analyzeImageInStreamAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter, ServiceCallback<ImageAnalysis> serviceCallback)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageAnalysis>> analyzeImageInStreamWithServiceResponseAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageAnalysis>> analyzeImageInStreamWithServiceResponseAsync(byte[] image, List<VisualFeatureTypes> visualFeatures, List<Details> details, String language, List<DescriptionExclude> descriptionExclude, String modelVersion)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageAnalysis>> analyzeImageWithServiceResponseAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageAnalysis>> analyzeImageWithServiceResponseAsync(String url, List<VisualFeatureTypes> visualFeatures, List<Details> details, String language, List<DescriptionExclude> descriptionExclude, String modelVersion)

This operation extracts a rich set of visual features based on the image content.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionDescribeImageParameters describeImage()

This operation generates a description of an image in human readable language with complete sentences.

ImageDescription describeImage(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<ImageDescription> describeImageAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

com.microsoft.rest.ServiceFuture<ImageDescription> describeImageAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter, ServiceCallback<ImageDescription> serviceCallback)

This operation generates a description of an image in human readable language with complete sentences.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionDescribeImageInStreamParameters describeImageInStream()

This operation generates a description of an image in human readable language with complete sentences.

ImageDescription describeImageInStream(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<ImageDescription> describeImageInStreamAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

com.microsoft.rest.ServiceFuture<ImageDescription> describeImageInStreamAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter, ServiceCallback<ImageDescription> serviceCallback)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageDescription>> describeImageInStreamWithServiceResponseAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageDescription>> describeImageInStreamWithServiceResponseAsync(byte[] image, Integer maxCandidates, String language, List<DescriptionExclude> descriptionExclude, String modelVersion)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageDescription>> describeImageWithServiceResponseAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences.

rx.Observable<com.microsoft.rest.ServiceResponse<ImageDescription>> describeImageWithServiceResponseAsync(String url, Integer maxCandidates, String language, List<DescriptionExclude> descriptionExclude, String modelVersion)

This operation generates a description of an image in human readable language with complete sentences.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionDetectObjectsParameters detectObjects()

Performs object detection on the specified image.

DetectResult detectObjects(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image.

rx.Observable<DetectResult> detectObjectsAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image.

com.microsoft.rest.ServiceFuture<DetectResult> detectObjectsAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter, ServiceCallback<DetectResult> serviceCallback)

Performs object detection on the specified image.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionDetectObjectsInStreamParameters detectObjectsInStream()

Performs object detection on the specified image.

DetectResult detectObjectsInStream(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image.

rx.Observable<DetectResult> detectObjectsInStreamAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image.

com.microsoft.rest.ServiceFuture<DetectResult> detectObjectsInStreamAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter, ServiceCallback<DetectResult> serviceCallback)

Performs object detection on the specified image.

rx.Observable<com.microsoft.rest.ServiceResponse<DetectResult>> detectObjectsInStreamWithServiceResponseAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image.

rx.Observable<com.microsoft.rest.ServiceResponse<DetectResult>> detectObjectsInStreamWithServiceResponseAsync(byte[] image, String modelVersion)

Performs object detection on the specified image.

rx.Observable<com.microsoft.rest.ServiceResponse<DetectResult>> detectObjectsWithServiceResponseAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image.

rx.Observable<com.microsoft.rest.ServiceResponse<DetectResult>> detectObjectsWithServiceResponseAsync(String url, String modelVersion)

Performs object detection on the specified image.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionGenerateThumbnailParameters generateThumbnail()

This operation generates a thumbnail image with the user-specified width and height.

InputStream generateThumbnail(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<InputStream> generateThumbnailAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

com.microsoft.rest.ServiceFuture<InputStream> generateThumbnailAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter, ServiceCallback<InputStream> serviceCallback)

This operation generates a thumbnail image with the user-specified width and height.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionGenerateThumbnailInStreamParameters generateThumbnailInStream()

This operation generates a thumbnail image with the user-specified width and height.

InputStream generateThumbnailInStream(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<InputStream> generateThumbnailInStreamAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

com.microsoft.rest.ServiceFuture<InputStream> generateThumbnailInStreamAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter, ServiceCallback<InputStream> serviceCallback)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<com.microsoft.rest.ServiceResponse<InputStream>> generateThumbnailInStreamWithServiceResponseAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<com.microsoft.rest.ServiceResponse<InputStream>> generateThumbnailInStreamWithServiceResponseAsync(int width, int height, byte[] image, Boolean smartCropping, String modelVersion)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<com.microsoft.rest.ServiceResponse<InputStream>> generateThumbnailWithServiceResponseAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height.

rx.Observable<com.microsoft.rest.ServiceResponse<InputStream>> generateThumbnailWithServiceResponseAsync(int width, int height, String url, Boolean smartCropping, String modelVersion)

This operation generates a thumbnail image with the user-specified width and height.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionGetAreaOfInterestParameters getAreaOfInterest()

This operation returns a bounding box around the most important area of the image.

AreaOfInterestResult getAreaOfInterest(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image.

rx.Observable<AreaOfInterestResult> getAreaOfInterestAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image.

com.microsoft.rest.ServiceFuture<AreaOfInterestResult> getAreaOfInterestAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter, ServiceCallback<AreaOfInterestResult> serviceCallback)

This operation returns a bounding box around the most important area of the image.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionGetAreaOfInterestInStreamParameters getAreaOfInterestInStream()

This operation returns a bounding box around the most important area of the image.

AreaOfInterestResult getAreaOfInterestInStream(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image.

rx.Observable<AreaOfInterestResult> getAreaOfInterestInStreamAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image.

com.microsoft.rest.ServiceFuture<AreaOfInterestResult> getAreaOfInterestInStreamAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter, ServiceCallback<AreaOfInterestResult> serviceCallback)

This operation returns a bounding box around the most important area of the image.

rx.Observable<com.microsoft.rest.ServiceResponse<AreaOfInterestResult>> getAreaOfInterestInStreamWithServiceResponseAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image.

rx.Observable<com.microsoft.rest.ServiceResponse<AreaOfInterestResult>> getAreaOfInterestInStreamWithServiceResponseAsync(byte[] image, String modelVersion)

This operation returns a bounding box around the most important area of the image.

rx.Observable<com.microsoft.rest.ServiceResponse<AreaOfInterestResult>> getAreaOfInterestWithServiceResponseAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image.

rx.Observable<com.microsoft.rest.ServiceResponse<AreaOfInterestResult>> getAreaOfInterestWithServiceResponseAsync(String url, String modelVersion)

This operation returns a bounding box around the most important area of the image.

ReadOperationResult getReadResult(UUID operationId)

This interface is used for getting OCR results of Read operation.

rx.Observable<ReadOperationResult> getReadResultAsync(UUID operationId)

This interface is used for getting OCR results of Read operation.

com.microsoft.rest.ServiceFuture<ReadOperationResult> getReadResultAsync(UUID operationId, ServiceCallback<ReadOperationResult> serviceCallback)

This interface is used for getting OCR results of Read operation.

rx.Observable<com.microsoft.rest.ServiceResponse<ReadOperationResult>> getReadResultWithServiceResponseAsync(UUID operationId)

This interface is used for getting OCR results of Read operation.

ListModelsResult listModels()

This operation returns the list of domain-specific models that are supported by the Computer Vision API.

rx.Observable<ListModelsResult> listModelsAsync()

This operation returns the list of domain-specific models that are supported by the Computer Vision API.

com.microsoft.rest.ServiceFuture<ListModelsResult> listModelsAsync(ServiceCallback<ListModelsResult> serviceCallback)

This operation returns the list of domain-specific models that are supported by the Computer Vision API.

rx.Observable<com.microsoft.rest.ServiceResponse<ListModelsResult>> listModelsWithServiceResponseAsync()

This operation returns the list of domain-specific models that are supported by the Computer Vision API.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionReadParameters read()

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

void read(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<Void> readAsync(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

com.microsoft.rest.ServiceFuture<Void> readAsync(String url, ReadOptionalParameter readOptionalParameter, ServiceCallback<Void> serviceCallback)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionReadInStreamParameters readInStream()

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

void readInStream(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<Void> readInStreamAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

com.microsoft.rest.ServiceFuture<Void> readInStreamAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter, ServiceCallback<Void> serviceCallback)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,ReadInStreamHeaders>> readInStreamWithServiceResponseAsync(byte[] image, OcrDetectionLanguage language, List<String> pages, String modelVersion, String readingOrder)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,ReadInStreamHeaders>> readInStreamWithServiceResponseAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,ReadHeaders>> readWithServiceResponseAsync(String url, OcrDetectionLanguage language, List<String> pages, String modelVersion, String readingOrder)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,ReadHeaders>> readWithServiceResponseAsync(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionRecognizePrintedTextParameters recognizePrintedText()

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

OcrResult recognizePrintedText(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<OcrResult> recognizePrintedTextAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

com.microsoft.rest.ServiceFuture<OcrResult> recognizePrintedTextAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter, ServiceCallback<OcrResult> serviceCallback)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionRecognizePrintedTextInStreamParameters recognizePrintedTextInStream()

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

OcrResult recognizePrintedTextInStream(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<OcrResult> recognizePrintedTextInStreamAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

com.microsoft.rest.ServiceFuture<OcrResult> recognizePrintedTextInStreamAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter, ServiceCallback<OcrResult> serviceCallback)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<com.microsoft.rest.ServiceResponse<OcrResult>> recognizePrintedTextInStreamWithServiceResponseAsync(boolean detectOrientation, byte[] image, OcrLanguages language, String modelVersion)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<com.microsoft.rest.ServiceResponse<OcrResult>> recognizePrintedTextInStreamWithServiceResponseAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<com.microsoft.rest.ServiceResponse<OcrResult>> recognizePrintedTextWithServiceResponseAsync(boolean detectOrientation, String url, OcrLanguages language, String modelVersion)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

rx.Observable<com.microsoft.rest.ServiceResponse<OcrResult>> recognizePrintedTextWithServiceResponseAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionTagImageParameters tagImage()

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

TagResult tagImage(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<TagResult> tagImageAsync(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

com.microsoft.rest.ServiceFuture<TagResult> tagImageAsync(String url, TagImageOptionalParameter tagImageOptionalParameter, ServiceCallback<TagResult> serviceCallback)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

com.microsoft.azure.cognitiveservices.vision.computervision.implementation.ComputerVisionImpl.ComputerVisionTagImageInStreamParameters tagImageInStream()

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

TagResult tagImageInStream(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<TagResult> tagImageInStreamAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

com.microsoft.rest.ServiceFuture<TagResult> tagImageInStreamAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter, ServiceCallback<TagResult> serviceCallback)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<com.microsoft.rest.ServiceResponse<TagResult>> tagImageInStreamWithServiceResponseAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<com.microsoft.rest.ServiceResponse<TagResult>> tagImageInStreamWithServiceResponseAsync(byte[] image, String language, String modelVersion)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<com.microsoft.rest.ServiceResponse<TagResult>> tagImageWithServiceResponseAsync(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

rx.Observable<com.microsoft.rest.ServiceResponse<TagResult>> tagImageWithServiceResponseAsync(String url, String language, String modelVersion)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image.

Methods inherited from java.lang.Object

Constructor Details

ComputerVisionImpl

public ComputerVisionImpl(Retrofit retrofit, ComputerVisionClientImpl client)

Initializes an instance of ComputerVisionImpl.

Parameters:

retrofit - the Retrofit instance built from a Retrofit Builder.
client - the instance of the service client containing this operation class.

Method Details

analyzeImage

public ComputerVisionImpl.ComputerVisionAnalyzeImageParameters analyzeImage()

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyzeImage

public ImageAnalysis analyzeImage(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
analyzeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImageAnalysis object if successful.

analyzeImageAsync

public Observable analyzeImageAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
analyzeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageAnalysis object

analyzeImageAsync

public ServiceFuture analyzeImageAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter, ServiceCallback serviceCallback)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
analyzeImageOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

analyzeImageByDomain

public ComputerVisionImpl.ComputerVisionAnalyzeImageByDomainParameters analyzeImageByDomain()

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyzeImageByDomain

public DomainModelResults analyzeImageByDomain(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
url - Publicly reachable URL of an image.
analyzeImageByDomainOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the DomainModelResults object if successful.

analyzeImageByDomainAsync

public Observable analyzeImageByDomainAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
url - Publicly reachable URL of an image.
analyzeImageByDomainOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DomainModelResults object

analyzeImageByDomainAsync

public ServiceFuture analyzeImageByDomainAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter, ServiceCallback serviceCallback)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
url - Publicly reachable URL of an image.
analyzeImageByDomainOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

analyzeImageByDomainInStream

public ComputerVisionImpl.ComputerVisionAnalyzeImageByDomainInStreamParameters analyzeImageByDomainInStream()

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyzeImageByDomainInStream

public DomainModelResults analyzeImageByDomainInStream(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
image - An image stream.
analyzeImageByDomainInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the DomainModelResults object if successful.

analyzeImageByDomainInStreamAsync

public Observable analyzeImageByDomainInStreamAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
image - An image stream.
analyzeImageByDomainInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DomainModelResults object

analyzeImageByDomainInStreamAsync

public ServiceFuture analyzeImageByDomainInStreamAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
image - An image stream.
analyzeImageByDomainInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

analyzeImageByDomainInStreamWithServiceResponseAsync

public Observable<>> analyzeImageByDomainInStreamWithServiceResponseAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
image - An image stream.
analyzeImageByDomainInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DomainModelResults object

analyzeImageByDomainInStreamWithServiceResponseAsync

public Observable<>> analyzeImageByDomainInStreamWithServiceResponseAsync(String model, byte[] image, String language, String modelVersion)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
image - An image stream.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the DomainModelResults object

analyzeImageByDomainWithServiceResponseAsync

public Observable<>> analyzeImageByDomainWithServiceResponseAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
url - Publicly reachable URL of an image.
analyzeImageByDomainOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DomainModelResults object

analyzeImageByDomainWithServiceResponseAsync

public Observable<>> analyzeImageByDomainWithServiceResponseAsync(String model, String url, String language, String modelVersion)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

model - The domain-specific content to recognize.
url - Publicly reachable URL of an image.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the DomainModelResults object

analyzeImageInStream

public ComputerVisionImpl.ComputerVisionAnalyzeImageInStreamParameters analyzeImageInStream()

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyzeImageInStream

public ImageAnalysis analyzeImageInStream(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
analyzeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImageAnalysis object if successful.

analyzeImageInStreamAsync

public Observable analyzeImageInStreamAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
analyzeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageAnalysis object

analyzeImageInStreamAsync

public ServiceFuture analyzeImageInStreamAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
analyzeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

analyzeImageInStreamWithServiceResponseAsync

public Observable<>> analyzeImageInStreamWithServiceResponseAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
analyzeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageAnalysis object

analyzeImageInStreamWithServiceResponseAsync

public Observable<>> analyzeImageInStreamWithServiceResponseAsync(byte[] image, List visualFeatures, List

details, String language, List descriptionExclude, String modelVersion)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
visualFeatures - A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.
details - A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
descriptionExclude - Turn off specified domain models when generating the description.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the ImageAnalysis object

analyzeImageWithServiceResponseAsync

public Observable<>> analyzeImageWithServiceResponseAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
analyzeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageAnalysis object

analyzeImageWithServiceResponseAsync

public Observable<>> analyzeImageWithServiceResponseAsync(String url, List visualFeatures, List

details, String language, List descriptionExclude, String modelVersion)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
visualFeatures - A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.
details - A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
descriptionExclude - Turn off specified domain models when generating the description.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the ImageAnalysis object

describeImage

public ComputerVisionImpl.ComputerVisionDescribeImageParameters describeImage()

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

describeImage

public ImageDescription describeImage(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
describeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImageDescription object if successful.

describeImageAsync

public Observable describeImageAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
describeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageDescription object

describeImageAsync

public ServiceFuture describeImageAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter, ServiceCallback serviceCallback)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
describeImageOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

describeImageInStream

public ComputerVisionImpl.ComputerVisionDescribeImageInStreamParameters describeImageInStream()

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

describeImageInStream

public ImageDescription describeImageInStream(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
describeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ImageDescription object if successful.

describeImageInStreamAsync

public Observable describeImageInStreamAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
describeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageDescription object

describeImageInStreamAsync

public ServiceFuture describeImageInStreamAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
describeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

describeImageInStreamWithServiceResponseAsync

public Observable<>> describeImageInStreamWithServiceResponseAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
describeImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageDescription object

describeImageInStreamWithServiceResponseAsync

public Observable<>> describeImageInStreamWithServiceResponseAsync(byte[] image, Integer maxCandidates, String language, List descriptionExclude, String modelVersion)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
maxCandidates - Maximum number of candidate descriptions to be returned. The default is 1.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
descriptionExclude - Turn off specified domain models when generating the description.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the ImageDescription object

describeImageWithServiceResponseAsync

public Observable<>> describeImageWithServiceResponseAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
describeImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the ImageDescription object

describeImageWithServiceResponseAsync

public Observable<>> describeImageWithServiceResponseAsync(String url, Integer maxCandidates, String language, List descriptionExclude, String modelVersion)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
maxCandidates - Maximum number of candidate descriptions to be returned. The default is 1.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
descriptionExclude - Turn off specified domain models when generating the description.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the ImageDescription object

detectObjects

public ComputerVisionImpl.ComputerVisionDetectObjectsParameters detectObjects()

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detectObjects

public DetectResult detectObjects(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
detectObjectsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the DetectResult object if successful.

detectObjectsAsync

public Observable detectObjectsAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
detectObjectsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DetectResult object

detectObjectsAsync

public ServiceFuture detectObjectsAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter, ServiceCallback serviceCallback)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
detectObjectsOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

detectObjectsInStream

public ComputerVisionImpl.ComputerVisionDetectObjectsInStreamParameters detectObjectsInStream()

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detectObjectsInStream

public DetectResult detectObjectsInStream(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
detectObjectsInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the DetectResult object if successful.

detectObjectsInStreamAsync

public Observable detectObjectsInStreamAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
detectObjectsInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DetectResult object

detectObjectsInStreamAsync

public ServiceFuture detectObjectsInStreamAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter, ServiceCallback serviceCallback)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
detectObjectsInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

detectObjectsInStreamWithServiceResponseAsync

public Observable<>> detectObjectsInStreamWithServiceResponseAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
detectObjectsInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DetectResult object

detectObjectsInStreamWithServiceResponseAsync

public Observable<>> detectObjectsInStreamWithServiceResponseAsync(byte[] image, String modelVersion)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the DetectResult object

detectObjectsWithServiceResponseAsync

public Observable<>> detectObjectsWithServiceResponseAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
detectObjectsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the DetectResult object

detectObjectsWithServiceResponseAsync

public Observable<>> detectObjectsWithServiceResponseAsync(String url, String modelVersion)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the DetectResult object

generateThumbnail

public ComputerVisionImpl.ComputerVisionGenerateThumbnailParameters generateThumbnail()

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

generateThumbnail

public InputStream generateThumbnail(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
url - Publicly reachable URL of an image.
generateThumbnailOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the InputStream object if successful.

generateThumbnailAsync

public Observable generateThumbnailAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
url - Publicly reachable URL of an image.
generateThumbnailOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the InputStream object

generateThumbnailAsync

public ServiceFuture generateThumbnailAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter, ServiceCallback serviceCallback)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
url - Publicly reachable URL of an image.
generateThumbnailOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

generateThumbnailInStream

public ComputerVisionImpl.ComputerVisionGenerateThumbnailInStreamParameters generateThumbnailInStream()

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

generateThumbnailInStream

public InputStream generateThumbnailInStream(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
image - An image stream.
generateThumbnailInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the InputStream object if successful.

generateThumbnailInStreamAsync

public Observable generateThumbnailInStreamAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
image - An image stream.
generateThumbnailInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the InputStream object

generateThumbnailInStreamAsync

public ServiceFuture generateThumbnailInStreamAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
image - An image stream.
generateThumbnailInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

generateThumbnailInStreamWithServiceResponseAsync

public Observable<>> generateThumbnailInStreamWithServiceResponseAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
image - An image stream.
generateThumbnailInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the InputStream object

generateThumbnailInStreamWithServiceResponseAsync

public Observable<>> generateThumbnailInStreamWithServiceResponseAsync(int width, int height, byte[] image, Boolean smartCropping, String modelVersion)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
image - An image stream.
smartCropping - Boolean flag for enabling smart cropping.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the InputStream object

generateThumbnailWithServiceResponseAsync

public Observable<>> generateThumbnailWithServiceResponseAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
url - Publicly reachable URL of an image.
generateThumbnailOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the InputStream object

generateThumbnailWithServiceResponseAsync

public Observable<>> generateThumbnailWithServiceResponseAsync(int width, int height, String url, Boolean smartCropping, String modelVersion)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

width - Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
height - Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.
url - Publicly reachable URL of an image.
smartCropping - Boolean flag for enabling smart cropping.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the InputStream object

getAreaOfInterest

public ComputerVisionImpl.ComputerVisionGetAreaOfInterestParameters getAreaOfInterest()

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

getAreaOfInterest

public AreaOfInterestResult getAreaOfInterest(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

url - Publicly reachable URL of an image.
getAreaOfInterestOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the AreaOfInterestResult object if successful.

getAreaOfInterestAsync

public Observable getAreaOfInterestAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

url - Publicly reachable URL of an image.
getAreaOfInterestOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the AreaOfInterestResult object

getAreaOfInterestAsync

public ServiceFuture getAreaOfInterestAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter, ServiceCallback serviceCallback)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

url - Publicly reachable URL of an image.
getAreaOfInterestOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getAreaOfInterestInStream

public ComputerVisionImpl.ComputerVisionGetAreaOfInterestInStreamParameters getAreaOfInterestInStream()

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

getAreaOfInterestInStream

public AreaOfInterestResult getAreaOfInterestInStream(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

image - An image stream.
getAreaOfInterestInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the AreaOfInterestResult object if successful.

getAreaOfInterestInStreamAsync

public Observable getAreaOfInterestInStreamAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

image - An image stream.
getAreaOfInterestInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the AreaOfInterestResult object

getAreaOfInterestInStreamAsync

public ServiceFuture getAreaOfInterestInStreamAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

image - An image stream.
getAreaOfInterestInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getAreaOfInterestInStreamWithServiceResponseAsync

public Observable<>> getAreaOfInterestInStreamWithServiceResponseAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

image - An image stream.
getAreaOfInterestInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the AreaOfInterestResult object

getAreaOfInterestInStreamWithServiceResponseAsync

public Observable<>> getAreaOfInterestInStreamWithServiceResponseAsync(byte[] image, String modelVersion)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

image - An image stream.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the AreaOfInterestResult object

getAreaOfInterestWithServiceResponseAsync

public Observable<>> getAreaOfInterestWithServiceResponseAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

url - Publicly reachable URL of an image.
getAreaOfInterestOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the AreaOfInterestResult object

getAreaOfInterestWithServiceResponseAsync

public Observable<>> getAreaOfInterestWithServiceResponseAsync(String url, String modelVersion)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

Parameters:

url - Publicly reachable URL of an image.
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the AreaOfInterestResult object

getReadResult

public ReadOperationResult getReadResult(UUID operationId)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.

Parameters:

operationId - Id of read operation returned in the response of the 'Read' interface.

Returns:

the ReadOperationResult object if successful.

getReadResultAsync

public Observable getReadResultAsync(UUID operationId)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.

Parameters:

operationId - Id of read operation returned in the response of the 'Read' interface.

Returns:

the observable to the ReadOperationResult object

getReadResultAsync

public ServiceFuture getReadResultAsync(UUID operationId, ServiceCallback serviceCallback)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.

Parameters:

operationId - Id of read operation returned in the response of the 'Read' interface.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getReadResultWithServiceResponseAsync

public Observable<>> getReadResultWithServiceResponseAsync(UUID operationId)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.

Parameters:

operationId - Id of read operation returned in the response of the 'Read' interface.

Returns:

the observable to the ReadOperationResult object

listModels

public ListModelsResult listModels()

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Returns:

the ListModelsResult object if successful.

listModelsAsync

public Observable listModelsAsync()

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Returns:

the observable to the ListModelsResult object

listModelsAsync

public ServiceFuture listModelsAsync(ServiceCallback serviceCallback)

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

listModelsWithServiceResponseAsync

public Observable<>> listModelsWithServiceResponseAsync()

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Returns:

the observable to the ListModelsResult object

read

public ComputerVisionImpl.ComputerVisionReadParameters read()

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

read

public void read(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

url - Publicly reachable URL of an image.
readOptionalParameter - the object representing the optional parameters to be set before calling this API

readAsync

public Observable readAsync(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

url - Publicly reachable URL of an image.
readOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ServiceResponseWithHeaders object if successful.

readAsync

public ServiceFuture readAsync(String url, ReadOptionalParameter readOptionalParameter, ServiceCallback serviceCallback)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

url - Publicly reachable URL of an image.
readOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

readInStream

public ComputerVisionImpl.ComputerVisionReadInStreamParameters readInStream()

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

readInStream

public void readInStream(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

image - An image stream.
readInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

readInStreamAsync

public Observable readInStreamAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

image - An image stream.
readInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ServiceResponseWithHeaders object if successful.

readInStreamAsync

public ServiceFuture readInStreamAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter, ServiceCallback serviceCallback)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

image - An image stream.
readInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

readInStreamWithServiceResponseAsync

public Observable<>> readInStreamWithServiceResponseAsync(byte[] image, OcrDetectionLanguage language, List pages, String modelVersion, String readingOrder)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

image - An image stream.
language - The BCP-47 language code of the text in the document. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the document to be processed in that specific language. See https://aka.ms/ocr-languages for list of supported languages. Possible values include: 'af', 'ast', 'bi', 'br', 'ca', 'ceb', 'ch', 'co', 'crh', 'cs', 'csb', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fil', 'fj', 'fr', 'fur', 'fy', 'ga', 'gd', 'gil', 'gl', 'gv', 'hni', 'hsb', 'ht', 'hu', 'ia', 'id', 'it', 'iu', 'ja', 'jv', 'kaa', 'kac', 'kea', 'kha', 'kl', 'ko', 'ku', 'kw', 'lb', 'ms', 'mww', 'nap', 'nl', 'no', 'oc', 'pl', 'pt', 'quc', 'rm', 'sco', 'sl', 'sq', 'sv', 'sw', 'tet', 'tr', 'tt', 'uz', 'vo', 'wae', 'yua', 'za', 'zh-Hans', 'zh-Hant', 'zu'
pages - Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages, use a hyphen. Separate each page or range with a comma.
modelVersion - Optional parameter to specify the version of the OCR model used for text extraction. Accepted values are: "latest", "latest-preview", "2021-04-12". Defaults to "latest".
readingOrder - Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to 'basic' if not specified

Returns:

the ServiceResponseWithHeaders object if successful.

readInStreamWithServiceResponseAsync

public Observable<>> readInStreamWithServiceResponseAsync(byte[] image, ReadInStreamOptionalParameter readInStreamOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

image - An image stream.
readInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ServiceResponseWithHeaders object if successful.

readWithServiceResponseAsync

public Observable<>> readWithServiceResponseAsync(String url, OcrDetectionLanguage language, List pages, String modelVersion, String readingOrder)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

url - Publicly reachable URL of an image.
language - The BCP-47 language code of the text in the document. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the document to be processed in that specific language. See https://aka.ms/ocr-languages for list of supported languages. Possible values include: 'af', 'ast', 'bi', 'br', 'ca', 'ceb', 'ch', 'co', 'crh', 'cs', 'csb', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fil', 'fj', 'fr', 'fur', 'fy', 'ga', 'gd', 'gil', 'gl', 'gv', 'hni', 'hsb', 'ht', 'hu', 'ia', 'id', 'it', 'iu', 'ja', 'jv', 'kaa', 'kac', 'kea', 'kha', 'kl', 'ko', 'ku', 'kw', 'lb', 'ms', 'mww', 'nap', 'nl', 'no', 'oc', 'pl', 'pt', 'quc', 'rm', 'sco', 'sl', 'sq', 'sv', 'sw', 'tet', 'tr', 'tt', 'uz', 'vo', 'wae', 'yua', 'za', 'zh-Hans', 'zh-Hant', 'zu'
pages - Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages, use a hyphen. Separate each page or range with a comma.
modelVersion - Optional parameter to specify the version of the OCR model used for text extraction. Accepted values are: "latest", "latest-preview", "2021-04-12". Defaults to "latest".
readingOrder - Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to 'basic' if not specified

Returns:

the ServiceResponseWithHeaders object if successful.

readWithServiceResponseAsync

public Observable<>> readWithServiceResponseAsync(String url, ReadOptionalParameter readOptionalParameter)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.\u200b.

Parameters:

url - Publicly reachable URL of an image.
readOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the ServiceResponseWithHeaders object if successful.

recognizePrintedText

public ComputerVisionImpl.ComputerVisionRecognizePrintedTextParameters recognizePrintedText()

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognizePrintedText

public OcrResult recognizePrintedText(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
url - Publicly reachable URL of an image.
recognizePrintedTextOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OcrResult object if successful.

recognizePrintedTextAsync

public Observable recognizePrintedTextAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
url - Publicly reachable URL of an image.
recognizePrintedTextOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OcrResult object

recognizePrintedTextAsync

public ServiceFuture recognizePrintedTextAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter, ServiceCallback serviceCallback)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
url - Publicly reachable URL of an image.
recognizePrintedTextOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

recognizePrintedTextInStream

public ComputerVisionImpl.ComputerVisionRecognizePrintedTextInStreamParameters recognizePrintedTextInStream()

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognizePrintedTextInStream

public OcrResult recognizePrintedTextInStream(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
image - An image stream.
recognizePrintedTextInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the OcrResult object if successful.

recognizePrintedTextInStreamAsync

public Observable recognizePrintedTextInStreamAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
image - An image stream.
recognizePrintedTextInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OcrResult object

recognizePrintedTextInStreamAsync

public ServiceFuture recognizePrintedTextInStreamAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter, ServiceCallback serviceCallback)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
image - An image stream.
recognizePrintedTextInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

recognizePrintedTextInStreamWithServiceResponseAsync

public Observable<>> recognizePrintedTextInStreamWithServiceResponseAsync(boolean detectOrientation, byte[] image, OcrLanguages language, String modelVersion)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
image - An image stream.
language - The BCP-47 language code of the text to be detected in the image. The default value is 'unk'. Possible values include: 'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the OcrResult object

recognizePrintedTextInStreamWithServiceResponseAsync

public Observable<>> recognizePrintedTextInStreamWithServiceResponseAsync(boolean detectOrientation, byte[] image, RecognizePrintedTextInStreamOptionalParameter recognizePrintedTextInStreamOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
image - An image stream.
recognizePrintedTextInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OcrResult object

recognizePrintedTextWithServiceResponseAsync

public Observable<>> recognizePrintedTextWithServiceResponseAsync(boolean detectOrientation, String url, OcrLanguages language, String modelVersion)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
url - Publicly reachable URL of an image.
language - The BCP-47 language code of the text to be detected in the image. The default value is 'unk'. Possible values include: 'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the OcrResult object

recognizePrintedTextWithServiceResponseAsync

public Observable<>> recognizePrintedTextWithServiceResponseAsync(boolean detectOrientation, String url, RecognizePrintedTextOptionalParameter recognizePrintedTextOptionalParameter)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

Parameters:

detectOrientation - Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).
url - Publicly reachable URL of an image.
recognizePrintedTextOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the OcrResult object

tagImage

public ComputerVisionImpl.ComputerVisionTagImageParameters tagImage()

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

tagImage

public TagResult tagImage(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
tagImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the TagResult object if successful.

tagImageAsync

public Observable tagImageAsync(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
tagImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TagResult object

tagImageAsync

public ServiceFuture tagImageAsync(String url, TagImageOptionalParameter tagImageOptionalParameter, ServiceCallback serviceCallback)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
tagImageOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

tagImageInStream

public ComputerVisionImpl.ComputerVisionTagImageInStreamParameters tagImageInStream()

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

tagImageInStream

public TagResult tagImageInStream(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
tagImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the TagResult object if successful.

tagImageInStreamAsync

public Observable tagImageInStreamAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
tagImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TagResult object

tagImageInStreamAsync

public ServiceFuture tagImageInStreamAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter, ServiceCallback serviceCallback)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
tagImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

tagImageInStreamWithServiceResponseAsync

public Observable<>> tagImageInStreamWithServiceResponseAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
tagImageInStreamOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TagResult object

tagImageInStreamWithServiceResponseAsync

public Observable<>> tagImageInStreamWithServiceResponseAsync(byte[] image, String language, String modelVersion)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

image - An image stream.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the TagResult object

tagImageWithServiceResponseAsync

public Observable<>> tagImageWithServiceResponseAsync(String url, TagImageOptionalParameter tagImageOptionalParameter)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
tagImageOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TagResult object

tagImageWithServiceResponseAsync

public Observable<>> tagImageWithServiceResponseAsync(String url, String language, String modelVersion)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

Parameters:

url - Publicly reachable URL of an image.
language - The desired language for output generation. If this parameter is not specified, the default value is &quot;en&quot;.Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
modelVersion - Optional parameter to specify the version of the AI model. Accepted values are: "latest", "2021-04-01". Defaults to "latest".

Returns:

the observable to the TagResult object

Applies to