ComputerVision Interface
public interface ComputerVision
An instance of this class provides access to all the operations defined in ComputerVision.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abstract
With |
analyzeImage()
This operation extracts a rich set of visual features based on the image content. |
|
abstract
Image |
analyzeImage(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)
This operation extracts a rich set of visual features based on the image content. |
|
abstract
rx.Observable<Image |
analyzeImageAsync(String url, AnalyzeImageOptionalParameter analyzeImageOptionalParameter)
This operation extracts a rich set of visual features based on the image content. |
|
abstract
With |
analyzeImageByDomain()
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
Domain |
analyzeImageByDomain(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
rx.Observable<Domain |
analyzeImageByDomainAsync(String model, String url, AnalyzeImageByDomainOptionalParameter analyzeImageByDomainOptionalParameter)
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
With |
analyzeImageByDomainInStream()
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
Domain |
analyzeImageByDomainInStream(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
rx.Observable<Domain |
analyzeImageByDomainInStreamAsync(String model, byte[] image, AnalyzeImageByDomainInStreamOptionalParameter analyzeImageByDomainInStreamOptionalParameter)
This operation recognizes content within an image by applying a domain-specific model. |
|
abstract
With |
analyzeImageInStream()
This operation extracts a rich set of visual features based on the image content. |
|
abstract
Image |
analyzeImageInStream(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)
This operation extracts a rich set of visual features based on the image content. |
|
abstract
rx.Observable<Image |
analyzeImageInStreamAsync(byte[] image, AnalyzeImageInStreamOptionalParameter analyzeImageInStreamOptionalParameter)
This operation extracts a rich set of visual features based on the image content. |
|
abstract
With |
describeImage()
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
Image |
describeImage(String url, DescribeImageOptionalParameter describeImageOptionalParameter)
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
rx.Observable<Image |
describeImageAsync(String url, DescribeImageOptionalParameter describeImageOptionalParameter)
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
With |
describeImageInStream()
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
Image |
describeImageInStream(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
rx.Observable<Image |
describeImageInStreamAsync(byte[] image, DescribeImageInStreamOptionalParameter describeImageInStreamOptionalParameter)
This operation generates a description of an image in human readable language with complete sentences. |
|
abstract
With |
detectObjects()
Performs object detection on the specified image. |
|
abstract
Detect |
detectObjects(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)
Performs object detection on the specified image. |
|
abstract
rx.Observable<Detect |
detectObjectsAsync(String url, DetectObjectsOptionalParameter detectObjectsOptionalParameter)
Performs object detection on the specified image. |
|
abstract
With |
detectObjectsInStream()
Performs object detection on the specified image. |
|
abstract
Detect |
detectObjectsInStream(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)
Performs object detection on the specified image. |
|
abstract
rx.Observable<Detect |
detectObjectsInStreamAsync(byte[] image, DetectObjectsInStreamOptionalParameter detectObjectsInStreamOptionalParameter)
Performs object detection on the specified image. |
|
abstract
With |
generateThumbnail()
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
Input |
generateThumbnail(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
rx.Observable<Input |
generateThumbnailAsync(int width, int height, String url, GenerateThumbnailOptionalParameter generateThumbnailOptionalParameter)
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
With |
generateThumbnailInStream()
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
Input |
generateThumbnailInStream(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
rx.Observable<Input |
generateThumbnailInStreamAsync(int width, int height, byte[] image, GenerateThumbnailInStreamOptionalParameter generateThumbnailInStreamOptionalParameter)
This operation generates a thumbnail image with the user-specified width and height. |
|
abstract
With |
getAreaOfInterest()
This operation returns a bounding box around the most important area of the image. |
|
abstract
Area |
getAreaOfInterest(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)
This operation returns a bounding box around the most important area of the image. |
|
abstract
rx.Observable<Area |
getAreaOfInterestAsync(String url, GetAreaOfInterestOptionalParameter getAreaOfInterestOptionalParameter)
This operation returns a bounding box around the most important area of the image. |
|
abstract
With |
getAreaOfInterestInStream()
This operation returns a bounding box around the most important area of the image. |
|
abstract
Area |
getAreaOfInterestInStream(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)
This operation returns a bounding box around the most important area of the image. |
|
abstract
rx.Observable<Area |
getAreaOfInterestInStreamAsync(byte[] image, GetAreaOfInterestInStreamOptionalParameter getAreaOfInterestInStreamOptionalParameter)
This operation returns a bounding box around the most important area of the image. |
|
abstract
Read |
getReadResult(UUID operationId)
This interface is used for getting OCR results of Read operation. |
|
abstract
rx.Observable<Read |
getReadResultAsync(UUID operationId)
This interface is used for getting OCR results of Read operation. |
|
abstract
List |
listModels()
This operation returns the list of domain-specific models that are supported by the Computer Vision API. |
|
abstract
rx.Observable<List |
listModelsAsync()
This operation returns the list of domain-specific models that are supported by the Computer Vision API. |
|
abstract
With |
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. |
| abstract 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. |
| abstract 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. |
|
abstract
With |
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. |
| abstract 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. |
| abstract 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. |
|
abstract
With |
recognizePrintedText()
Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. |
|
abstract
Ocr |
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. |
|
abstract
rx.Observable<Ocr |
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. |
|
abstract
With |
recognizePrintedTextInStream()
Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. |
|
abstract
Ocr |
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. |
|
abstract
rx.Observable<Ocr |
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. |
|
abstract
With |
tagImage()
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
|
abstract
Tag |
tagImage(String url, TagImageOptionalParameter tagImageOptionalParameter)
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
|
abstract
rx.Observable<Tag |
tagImageAsync(String url, TagImageOptionalParameter tagImageOptionalParameter)
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
|
abstract
With |
tagImageInStream()
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
|
abstract
Tag |
tagImageInStream(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
|
abstract
rx.Observable<Tag |
tagImageInStreamAsync(byte[] image, TagImageInStreamOptionalParameter tagImageInStreamOptionalParameter)
This operation generates a list of words, or tags, that are relevant to the content of the supplied image. |
Method Details
analyzeImage
public abstract ComputerVision.ComputerVisionAnalyzeImageDefinitionStages.WithUrl 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.
Returns:
analyzeImage
public abstract 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:
Returns:
analyzeImageAsync
public abstract Observable
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:
Returns:
analyzeImageByDomain
public abstract ComputerVision.ComputerVisionAnalyzeImageByDomainDefinitionStages.WithModel 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.
Returns:
analyzeImageByDomain
public abstract 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:
Returns:
analyzeImageByDomainAsync
public abstract Observable
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:
Returns:
analyzeImageByDomainInStream
public abstract ComputerVision.ComputerVisionAnalyzeImageByDomainInStreamDefinitionStages.WithModel 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.
Returns:
analyzeImageByDomainInStream
public abstract 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:
Returns:
analyzeImageByDomainInStreamAsync
public abstract Observable
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:
Returns:
analyzeImageInStream
public abstract ComputerVision.ComputerVisionAnalyzeImageInStreamDefinitionStages.WithImage 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.
Returns:
analyzeImageInStream
public abstract 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:
Returns:
analyzeImageInStreamAsync
public abstract Observable
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:
Returns:
describeImage
public abstract ComputerVision.ComputerVisionDescribeImageDefinitionStages.WithUrl 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.
Returns:
describeImage
public abstract 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:
Returns:
describeImageAsync
public abstract Observable
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:
Returns:
describeImageInStream
public abstract ComputerVision.ComputerVisionDescribeImageInStreamDefinitionStages.WithImage 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.
Returns:
describeImageInStream
public abstract 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:
Returns:
describeImageInStreamAsync
public abstract Observable
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:
Returns:
detectObjects
public abstract ComputerVision.ComputerVisionDetectObjectsDefinitionStages.WithUrl 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.
Returns:
detectObjects
public abstract 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:
Returns:
detectObjectsAsync
public abstract Observable
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:
Returns:
detectObjectsInStream
public abstract ComputerVision.ComputerVisionDetectObjectsInStreamDefinitionStages.WithImage 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.
Returns:
detectObjectsInStream
public abstract 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:
Returns:
detectObjectsInStreamAsync
public abstract Observable
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:
Returns:
generateThumbnail
public abstract ComputerVision.ComputerVisionGenerateThumbnailDefinitionStages.WithWidth 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.
Returns:
generateThumbnail
public abstract 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:
Returns:
generateThumbnailAsync
public abstract Observable
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:
Returns:
generateThumbnailInStream
public abstract ComputerVision.ComputerVisionGenerateThumbnailInStreamDefinitionStages.WithWidth 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.
Returns:
generateThumbnailInStream
public abstract 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:
Returns:
generateThumbnailInStreamAsync
public abstract Observable
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:
Returns:
getAreaOfInterest
public abstract ComputerVision.ComputerVisionGetAreaOfInterestDefinitionStages.WithUrl 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.
Returns:
getAreaOfInterest
public abstract 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:
Returns:
getAreaOfInterestAsync
public abstract Observable
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:
Returns:
getAreaOfInterestInStream
public abstract ComputerVision.ComputerVisionGetAreaOfInterestInStreamDefinitionStages.WithImage 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.
Returns:
getAreaOfInterestInStream
public abstract 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:
Returns:
getAreaOfInterestInStreamAsync
public abstract Observable
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:
Returns:
getReadResult
public abstract 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:
Returns:
getReadResultAsync
public abstract Observable
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:
Returns:
listModels
public abstract 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:
listModelsAsync
public abstract Observable
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:
read
public abstract ComputerVision.ComputerVisionReadDefinitionStages.WithUrl 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.
Returns:
read
public abstract 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:
readAsync
public abstract Observable
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:
Returns:
readInStream
public abstract ComputerVision.ComputerVisionReadInStreamDefinitionStages.WithImage 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.
Returns:
readInStream
public abstract 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:
readInStreamAsync
public abstract Observable
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:
Returns:
recognizePrintedText
public abstract ComputerVision.ComputerVisionRecognizePrintedTextDefinitionStages.WithDetectOrientation 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.
Returns:
recognizePrintedText
public abstract 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:
Returns:
recognizePrintedTextAsync
public abstract Observable
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:
Returns:
recognizePrintedTextInStream
public abstract ComputerVision.ComputerVisionRecognizePrintedTextInStreamDefinitionStages.WithDetectOrientation 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.
Returns:
recognizePrintedTextInStream
public abstract 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:
Returns:
recognizePrintedTextInStreamAsync
public abstract Observable
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:
Returns:
tagImage
public abstract ComputerVision.ComputerVisionTagImageDefinitionStages.WithUrl 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.
Returns:
tagImage
public abstract 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:
Returns:
tagImageAsync
public abstract Observable
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:
Returns:
tagImageInStream
public abstract ComputerVision.ComputerVisionTagImageInStreamDefinitionStages.WithImage 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.
Returns:
tagImageInStream
public abstract 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:
Returns:
tagImageInStreamAsync
public abstract Observable
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:
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for