Documentation ¶
Overview ¶
Package vision is an experimental, auto-generated package for the Google Cloud Vision API.
Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.
Use the client at cloud.google.com/go/vision in preference to this.
Index ¶
- func DefaultAuthScopes() []string
- func NewImageFromReader(r io.Reader) (*pb.Image, error)
- func NewImageFromURI(uri string) *pb.Image
- type Chin
- type Ears
- type Eye
- type Eyebrow
- type Eyebrows
- type Eyes
- type FaceLandmarks
- type ImageAnnotatorCallOptions
- type ImageAnnotatorClient
- func (c *ImageAnnotatorClient) AnnotateImage(ctx context.Context, req *pb.AnnotateImageRequest, opts ...gax.CallOption) (*pb.AnnotateImageResponse, error)
- func (c *ImageAnnotatorClient) BatchAnnotateImages(ctx context.Context, req *visionpb.BatchAnnotateImagesRequest, ...) (*visionpb.BatchAnnotateImagesResponse, error)
- func (c *ImageAnnotatorClient) Close() error
- func (c *ImageAnnotatorClient) Connection() *grpc.ClientConn
- func (c *ImageAnnotatorClient) CropHints(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, ...) (*pb.CropHintsAnnotation, error)
- func (c *ImageAnnotatorClient) DetectDocumentText(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, ...) (*pb.TextAnnotation, error)
- func (c *ImageAnnotatorClient) DetectFaces(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, ...) ([]*pb.FaceAnnotation, error)
- func (c *ImageAnnotatorClient) DetectImageProperties(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, ...) (*pb.ImageProperties, error)
- func (c *ImageAnnotatorClient) DetectLabels(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, ...) ([]*pb.EntityAnnotation, error)
- func (c *ImageAnnotatorClient) DetectLandmarks(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, ...) ([]*pb.EntityAnnotation, error)
- func (c *ImageAnnotatorClient) DetectLogos(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, ...) ([]*pb.EntityAnnotation, error)
- func (c *ImageAnnotatorClient) DetectSafeSearch(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, ...) (*pb.SafeSearchAnnotation, error)
- func (c *ImageAnnotatorClient) DetectTexts(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, ...) ([]*pb.EntityAnnotation, error)
- func (c *ImageAnnotatorClient) DetectWeb(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, ...) (*pb.WebDetection, error)
- func (c *ImageAnnotatorClient) SetGoogleClientInfo(keyval ...string)
- type Mouth
- type Nose
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶ added in v0.8.0
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
func NewImageFromReader ¶ added in v0.8.0
NewImageFromReader reads the bytes of an image from r.
func NewImageFromURI ¶ added in v0.8.0
NewImageFromURI returns an image that refers to an object in Google Cloud Storage (when the uri is of the form "gs://BUCKET/OBJECT") or at a public URL.
Types ¶
type Eyebrows ¶ added in v0.8.0
type Eyebrows struct {
Left, Right Eyebrow
}
Eyebrows represents a face's eyebrows.
type FaceLandmarks ¶ added in v0.8.0
type FaceLandmarks struct { Eyebrows Eyebrows Eyes Eyes Ears Ears Nose Nose Mouth Mouth Chin Chin Forehead *pb.Position }
FaceLandmarks contains the positions of facial features detected by the service.
func FaceFromLandmarks ¶ added in v0.8.0
func FaceFromLandmarks(landmarks []*pb.FaceAnnotation_Landmark) *FaceLandmarks
FaceFromLandmarks converts the list of face landmarks returned by the service to a FaceLandmarks struct.
type ImageAnnotatorCallOptions ¶ added in v0.3.0
type ImageAnnotatorCallOptions struct {
BatchAnnotateImages []gax.CallOption
}
ImageAnnotatorCallOptions contains the retry settings for each method of ImageAnnotatorClient.
type ImageAnnotatorClient ¶ added in v0.3.0
type ImageAnnotatorClient struct { // The call options for this service. CallOptions *ImageAnnotatorCallOptions // contains filtered or unexported fields }
ImageAnnotatorClient is a client for interacting with Google Cloud Vision API.
func NewImageAnnotatorClient ¶ added in v0.3.0
func NewImageAnnotatorClient(ctx context.Context, opts ...option.ClientOption) (*ImageAnnotatorClient, error)
NewImageAnnotatorClient creates a new image annotator client.
Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.
Example ¶
ctx := context.Background() c, err := vision.NewImageAnnotatorClient(ctx) if err != nil { // TODO: Handle error. } // TODO: Use client. _ = c
Output:
func (*ImageAnnotatorClient) AnnotateImage ¶ added in v0.8.0
func (c *ImageAnnotatorClient) AnnotateImage(ctx context.Context, req *pb.AnnotateImageRequest, opts ...gax.CallOption) (*pb.AnnotateImageResponse, error)
AnnotateImage runs image detection and annotation for a single image.
Example ¶
package main import ( vision "cloud.google.com/go/vision/apiv1" "golang.org/x/net/context" pb "google.golang.org/genproto/googleapis/cloud/vision/v1" ) func main() { ctx := context.Background() c, err := vision.NewImageAnnotatorClient(ctx) if err != nil { // TODO: Handle error. } res, err := c.AnnotateImage(ctx, &pb.AnnotateImageRequest{ Image: vision.NewImageFromURI("gs://my-bucket/my-image.png"), Features: []*pb.Feature{ {Type: pb.Feature_LANDMARK_DETECTION, MaxResults: 5}, {Type: pb.Feature_LABEL_DETECTION, MaxResults: 3}, }, }) if err != nil { // TODO: Handle error. } // TODO: Use res. _ = res }
Output:
func (*ImageAnnotatorClient) BatchAnnotateImages ¶ added in v0.3.0
func (c *ImageAnnotatorClient) BatchAnnotateImages(ctx context.Context, req *visionpb.BatchAnnotateImagesRequest, opts ...gax.CallOption) (*visionpb.BatchAnnotateImagesResponse, error)
BatchAnnotateImages run image detection and annotation for a batch of images.
Example ¶
ctx := context.Background() c, err := vision.NewImageAnnotatorClient(ctx) if err != nil { // TODO: Handle error. } req := &visionpb.BatchAnnotateImagesRequest{ // TODO: Fill request struct fields. } resp, err := c.BatchAnnotateImages(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Output:
func (*ImageAnnotatorClient) Close ¶ added in v0.3.0
func (c *ImageAnnotatorClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ImageAnnotatorClient) Connection ¶ added in v0.3.0
func (c *ImageAnnotatorClient) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.
func (*ImageAnnotatorClient) CropHints ¶ added in v0.8.0
func (c *ImageAnnotatorClient) CropHints(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, opts ...gax.CallOption) (*pb.CropHintsAnnotation, error)
CropHints computes crop hints for the image.
func (*ImageAnnotatorClient) DetectDocumentText ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectDocumentText(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, opts ...gax.CallOption) (*pb.TextAnnotation, error)
DetectDocumentText performs full text (OCR) detection on the image.
func (*ImageAnnotatorClient) DetectFaces ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectFaces(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, opts ...gax.CallOption) ([]*pb.FaceAnnotation, error)
DetectFaces performs face detection on the image. At most maxResults results are returned.
func (*ImageAnnotatorClient) DetectImageProperties ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectImageProperties(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, opts ...gax.CallOption) (*pb.ImageProperties, error)
DetectImageProperties computes properties of the image.
func (*ImageAnnotatorClient) DetectLabels ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectLabels(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, opts ...gax.CallOption) ([]*pb.EntityAnnotation, error)
DetectLabels performs label detection on the image. At most maxResults results are returned.
func (*ImageAnnotatorClient) DetectLandmarks ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectLandmarks(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, opts ...gax.CallOption) ([]*pb.EntityAnnotation, error)
DetectLandmarks performs landmark detection on the image. At most maxResults results are returned.
func (*ImageAnnotatorClient) DetectLogos ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectLogos(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, opts ...gax.CallOption) ([]*pb.EntityAnnotation, error)
DetectLogos performs logo detection on the image. At most maxResults results are returned.
func (*ImageAnnotatorClient) DetectSafeSearch ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectSafeSearch(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, opts ...gax.CallOption) (*pb.SafeSearchAnnotation, error)
DetectSafeSearch performs safe-search detection on the image.
func (*ImageAnnotatorClient) DetectTexts ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectTexts(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, maxResults int, opts ...gax.CallOption) ([]*pb.EntityAnnotation, error)
DetectTexts performs text detection on the image. At most maxResults results are returned.
func (*ImageAnnotatorClient) DetectWeb ¶ added in v0.8.0
func (c *ImageAnnotatorClient) DetectWeb(ctx context.Context, img *pb.Image, ictx *pb.ImageContext, opts ...gax.CallOption) (*pb.WebDetection, error)
DetectWeb computes a web annotation on the image.
func (*ImageAnnotatorClient) SetGoogleClientInfo ¶ added in v0.3.0
func (c *ImageAnnotatorClient) SetGoogleClientInfo(keyval ...string)
SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.