Class v1p2beta1.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. v1p2beta1

Package

@google-cloud/vision

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ImageAnnotatorClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

imageAnnotatorStub

imageAnnotatorStub?: Promise<{
        [name: string]: Function;
    }>;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

asyncBatchAnnotateFiles(request, options)

asyncBatchAnnotateFiles(request?: protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Run async image detection and annotation for a list of generic files (e.g. PDF) which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Individual async file annotation requests for this batch.
   */
  // const requests = 1234

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

  // 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();

asyncBatchAnnotateFiles(request, options, callback)

asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

asyncBatchAnnotateFiles(request, callback)

asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesRequest
callback Callback<LROperation<protos.google.cloud.vision.v1p2beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchAnnotateImages(request, options)

batchAnnotateImages(request?: protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>;

Run image detection and annotation for a batch of images.

Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [BatchAnnotateImagesResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Individual image annotation requests for this batch.
   */
  // const requests = 1234

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

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

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

    // Run request
    const response = await visionClient.batchAnnotateImages(request);
    console.log(response);
  }

  callBatchAnnotateImages();

batchAnnotateImages(request, options, callback)

batchAnnotateImages(request: protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchAnnotateImages(request, callback)

batchAnnotateImages(request: protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest
callback Callback<protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p2beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkAsyncBatchAnnotateFilesProgress(name)

checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.OperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Individual async file annotation requests for this batch.
   */
  // const requests = 1234

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

  // 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()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.