ImageAnnotatorClient

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.

Constructor

new ImageAnnotatorClient(optionsopt, gaxInstanceopt)

Construct an instance of ImageAnnotatorClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ImageAnnotatorClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

(async) checkAsyncBatchAnnotateFilesProgress(name) → {Promise}

Check the status of the long running operation returned by asyncBatchAnnotateFiles().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Individual async file annotation requests for this batch.
   */
  // const requests = [1,2,3,4]

  // Imports the Vision library
  const {ImageAnnotatorClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ImageAnnotatorClient();

  async function callAsyncBatchAnnotateFiles() {
    // Construct request
    const request = {
      requests,
    };

    // Run request
    const [operation] = await visionClient.asyncBatchAnnotateFiles(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callAsyncBatchAnnotateFiles();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

matchLocationFromProductName(productName) → {string}

Parse the location from Product resource.

Parameters:

Name	Type	Description
`productName`	string	A fully-qualified path representing Product resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProductSetName(productSetName) → {string}

Parse the location from ProductSet resource.

Parameters:

Name	Type	Description
`productSetName`	string	A fully-qualified path representing ProductSet resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromReferenceImageName(referenceImageName) → {string}

Parse the location from ReferenceImage resource.

Parameters:

Name	Type	Description
`referenceImageName`	string	A fully-qualified path representing ReferenceImage resource.

Returns:

Type	Description
string	A string representing the location.

matchProductFromProductName(productName) → {string}

Parse the product from Product resource.

Parameters:

Name	Type	Description
`productName`	string	A fully-qualified path representing Product resource.

Returns:

Type	Description
string	A string representing the product.

matchProductFromReferenceImageName(referenceImageName) → {string}

Parse the product from ReferenceImage resource.

Parameters:

Name	Type	Description
`referenceImageName`	string	A fully-qualified path representing ReferenceImage resource.

Returns:

Type	Description
string	A string representing the product.

matchProductSetFromProductSetName(productSetName) → {string}

Parse the product_set from ProductSet resource.

Parameters:

Name	Type	Description
`productSetName`	string	A fully-qualified path representing ProductSet resource.

Returns:

Type	Description
string	A string representing the product_set.

matchProjectFromProductName(productName) → {string}

Parse the project from Product resource.

Parameters:

Name	Type	Description
`productName`	string	A fully-qualified path representing Product resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProductSetName(productSetName) → {string}

Parse the project from ProductSet resource.

Parameters:

Name	Type	Description
`productSetName`	string	A fully-qualified path representing ProductSet resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromReferenceImageName(referenceImageName) → {string}

Parse the project from ReferenceImage resource.

Parameters:

Name	Type	Description
`referenceImageName`	string	A fully-qualified path representing ReferenceImage resource.

Returns:

Type	Description
string	A string representing the project.

matchReferenceImageFromReferenceImageName(referenceImageName) → {string}

Parse the reference_image from ReferenceImage resource.

Parameters:

Name	Type	Description
`referenceImageName`	string	A fully-qualified path representing ReferenceImage resource.

Returns:

Type	Description
string	A string representing the reference_image.

objectLocalization(request, callOptionsopt, callbackopt) → {Promise}

Annotate a single image with localization vectors.

Parameters:

Name Type Attributes Description

request

object | string | Buffer

A representation of the request being sent to the Vision API. This is an AnnotateImageRequest. For simple cases, you may also send a string (the URL or filename of the image) or a buffer (the image itself).

Properties

Name Type Description

image

object

A dictionary-like object representing the image. This should have a single key (source, content).

If the key is `source`, the value should be another object containing
`imageUri` or `filename` as a key and a string as a value.

If the key is `content`, the value should be base64 encoded text.
See https:\\/\\/cloud.google.com/vision/docs/base64 for the details.

callOptions

object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing
BatchAnnotateImagesResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing BatchAnnotateImagesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

See:

v1p3beta1.ImageAnnotatorClient#batchAnnotateImages
google.cloud.vision.v1p3beta1.AnnotateImageRequest

Example

// Object localization is only available in v1p3beta1.
const vision = require('@google-cloud/vision').v1p3beta1;
const client = new vision.ImageAnnotatorClient();

const request = {
  image: {
    source: {imageUri: 'gs://path/to/image.jpg'}
  }
};

client
  .objectLocalization(request)
  .then(response => {
    // doThingsWith(response);
  })
  .catch(err => {
    console.error(err);
  });

productPath(project, location, product) → {string}

Return a fully-qualified product resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`product`	string

Returns:

Type	Description
string	Resource name string.

productSearch(request, callOptionsopt, callbackopt) → {Promise}

Annotate a single image with the result from Product Search.

Parameters:

Name Type Attributes Description

request

object | string | Buffer

Properties

Name Type Description

image

object

A dictionary-like object representing the image. This should have a single key (source, content).

If the key is `source`, the value should be another object containing
`imageUri` or `filename` as a key and a string as a value.

If the key is `content`, the value should be base64 encoded text.
See https:\\/\\/cloud.google.com/vision/docs/base64 for the details.

callOptions

object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations,

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing
BatchAnnotateImagesResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing BatchAnnotateImagesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

See:

v1p3beta1.ImageAnnotatorClient#batchAnnotateImages
google.cloud.vision.v1p3beta1.AnnotateImageRequest

Example

const vision = require('@google-cloud/vision').v1p3beta1;
const client = new vision.ImageAnnotatorClient();

const request = {
  image: {
    source: {imageUri: 'gs://path/to/image.jpg'}
  }
};

client
  .productSearch(request)
  .then(response => {
    // doThingsWith(response);
  })
  .catch(err => {
    console.error(err);
  });

productSetPath(project, location, product_set) → {string}

Return a fully-qualified productSet resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`product_set`	string

Returns:

Type	Description
string	Resource name string.

referenceImagePath(project, location, product, reference_image) → {string}

Return a fully-qualified referenceImage resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`product`	string
`reference_image`	string

Returns:

Type	Description
string	Resource name string.