UNPKG

@google-cloud/vision

Version:

Google Cloud Vision API client for Node.js

99 lines (98 loc) 4.77 kB
import * as gax from 'google-gax'; import { Callback, Descriptors, ClientOptions } from 'google-gax'; import * as protos from '../../protos/protos'; /** * 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. * @class * @memberof v1p1beta1 */ export declare class ImageAnnotatorClient { private _terminated; private _opts; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; auth: gax.GoogleAuth; descriptors: Descriptors; innerApiCalls: { [name: string]: Function; }; imageAnnotatorStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ImageAnnotatorClient. * * @param {object} [options] - The configuration object. See the subsequent * parameters for more details. * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - 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. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - 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 * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. */ constructor(opts?: ClientOptions); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath(), * exists for compatibility reasons. */ static get apiEndpoint(): string; /** * The port for this API service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. */ static get scopes(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; batchAnnotateImages(request: protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest, options?: gax.CallOptions): Promise<[protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>; batchAnnotateImages(request: protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest, options: gax.CallOptions, callback: Callback<protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; batchAnnotateImages(request: protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; /** * Terminate the GRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. */ close(): Promise<void>; } import { FeaturesMethod } from '../helpers'; export interface ImageAnnotatorClient extends FeaturesMethod { }