org.springframework.cloud.gcp.vision

Class CloudVisionTemplate

java.lang.Object

org.springframework.cloud.gcp.vision.CloudVisionTemplate

public class CloudVisionTemplate
extends Object

Spring Template offering convenience methods for interacting with the Cloud Vision APIs.

Since:

1.1

Author:

Daniel Zou

Constructor Summary

Constructors

Constructor and Description
CloudVisionTemplate(ImageAnnotatorClient imageAnnotatorClient)

Method Summary

Modifier and Type	Method and Description
AnnotateImageResponse	analyzeImage(org.springframework.core.io.Resource imageResource, Feature.Type... featureTypes) Analyze an image and extract the features of the image specified by featureTypes.
AnnotateImageResponse	analyzeImage(org.springframework.core.io.Resource imageResource, ImageContext imageContext, Feature.Type... featureTypes) Analyze an image and extract the features of the image specified by featureTypes.
String	extractTextFromImage(org.springframework.core.io.Resource imageResource) Extract the text out of an image and return the result as a String.
String	extractTextFromImage(org.springframework.core.io.Resource imageResource, ImageContext imageContext) Extract the text out of an image and return the result as a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudVisionTemplate

public CloudVisionTemplate(ImageAnnotatorClient imageAnnotatorClient)

Method Detail

extractTextFromImage

public String extractTextFromImage(org.springframework.core.io.Resource imageResource)

Extract the text out of an image and return the result as a String.

Parameters:

imageResource - the image one wishes to analyze

Returns:

the text extracted from the image aggregated to a String

Throws:

CloudVisionException - if the image could not be read or if text extraction failed

extractTextFromImage

public String extractTextFromImage(org.springframework.core.io.Resource imageResource,
                                   ImageContext imageContext)

Extract the text out of an image and return the result as a String.

Parameters:

imageResource - the image one wishes to analyze

imageContext - the image context to customize the text extraction request

Returns:

the text extracted from the image aggregated to a String

Throws:

CloudVisionException - if the image could not be read or if text extraction failed

analyzeImage

public AnnotateImageResponse analyzeImage(org.springframework.core.io.Resource imageResource,
                                          Feature.Type... featureTypes)

Analyze an image and extract the features of the image specified by featureTypes.

A feature describes the kind of Cloud Vision analysis one wishes to perform on an image, such as text detection, image labelling, facial detection, etc. A full list of feature types can be found in Feature.Type.

Parameters:

imageResource - the image one wishes to analyze. The Cloud Vision APIs support image formats described here: https://cloud.google.com/vision/docs/supported-files

featureTypes - the types of image analysis to perform on the image

Returns:

the results of image analyses

Throws:

CloudVisionException - if the image could not be read or if a malformed response is received from the Cloud Vision APIs

analyzeImage

public AnnotateImageResponse analyzeImage(org.springframework.core.io.Resource imageResource,
                                          ImageContext imageContext,
                                          Feature.Type... featureTypes)

Analyze an image and extract the features of the image specified by featureTypes.

A feature describes the kind of Cloud Vision analysis one wishes to perform on an image, such as text detection, image labelling, facial detection, etc. A full list of feature types can be found in Feature.Type.

Parameters:

imageResource - the image one wishes to analyze. The Cloud Vision APIs support image formats described here: https://cloud.google.com/vision/docs/supported-files

imageContext - the image context used to customize the Vision API request

featureTypes - the types of image analysis to perform on the image

Returns:

the results of image analyses

Throws:

CloudVisionException - if the image could not be read or if a malformed response is received from the Cloud Vision APIs