vision

README

Auto-generated vision v1 clients

This package includes auto-generated clients for the vision v1 API.

Use the handwritten client (in the parent directory, cloud.google.com/go/vision) in preference to this.

This code is EXPERIMENTAL and subject to CHANGE AT ANY TIME.

Documentation

Overview

Package vision is an experimental, auto-generated package for the 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

• type ImageAnnotatorCallOptions
• type ImageAnnotatorClient
  • func NewImageAnnotatorClient(ctx context.Context, opts ...option.ClientOption) (*ImageAnnotatorClient, 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) SetGoogleClientInfo(name, version string)

Examples

• ImageAnnotatorClient.BatchAnnotateImages
• NewImageAnnotatorClient

Types

type ImageAnnotatorCallOptions

type ImageAnnotatorCallOptions struct {
	BatchAnnotateImages []gax.CallOption
}

ImageAnnotatorCallOptions contains the retry settings for each method of ImageAnnotatorClient.

type ImageAnnotatorClient

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

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, such as face, landmark, logo, label, and text detection, over client images, and 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

func (*ImageAnnotatorClient) BatchAnnotateImages

func (c *ImageAnnotatorClient) BatchAnnotateImages(ctx context.Context, req *visionpb.BatchAnnotateImagesRequest) (*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

func (*ImageAnnotatorClient) Close

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

func (c *ImageAnnotatorClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*ImageAnnotatorClient) SetGoogleClientInfo

func (c *ImageAnnotatorClient) SetGoogleClientInfo(name, version 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.