@google-cloud/vision
Advanced tools
Comparing version 2.4.0 to 2.4.1
@@ -144,3 +144,3 @@ "use strict"; | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -232,3 +232,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -287,3 +287,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -342,3 +342,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -397,3 +397,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -452,3 +452,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -507,3 +507,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -562,3 +562,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -617,3 +617,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -672,3 +672,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -727,3 +727,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -836,3 +836,3 @@ * @param {function(?Error, ?object)} [callback] The function which will be | ||
* default settings for this call, e.g, timeout, retries, paginations, | ||
* etc. See [gax.CallOptions]{@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions} | ||
* etc. See {@link https://googleapis.github.io/gax-nodejs/global.html#CallOptions| gax.CallOptions} | ||
* for the details. | ||
@@ -839,0 +839,0 @@ * @param {function(?Error, ?object)} [callback] The function which will be |
@@ -105,8 +105,117 @@ import * as gax from 'google-gax'; | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/image_annotator.batch_annotate_images.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_BatchAnnotateImages_async | ||
*/ | ||
batchAnnotateImages(request?: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | undefined, {} | undefined]>; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Service that performs image detection and annotation for a batch of files. | ||
* Now only "application/pdf", "image/tiff" and "image/gif" are supported. | ||
* | ||
* This service will extract at most 5 (customers can specify which 5 in | ||
* AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each | ||
* file provided and perform detection and annotation for each image | ||
* extracted. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. The list of file annotation requests. Right now we support only | ||
* one AnnotateFileRequest in BatchAnnotateFilesRequest. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateFilesResponse]{@link google.cloud.vision.v1.BatchAnnotateFilesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1/image_annotator.batch_annotate_files.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_BatchAnnotateFiles_async | ||
*/ | ||
batchAnnotateFiles(request?: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | undefined, {} | undefined]>; | ||
batchAnnotateFiles(request: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void; | ||
batchAnnotateFiles(request: protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest, callback: Callback<protos.google.cloud.vision.v1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Run asynchronous image detection and annotation for a list of images. | ||
* | ||
* Progress and results can be retrieved through the | ||
* `google.longrunning.Operations` interface. | ||
* `Operation.metadata` contains `OperationMetadata` (metadata). | ||
* `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). | ||
* | ||
* This service will write image annotation outputs to json files in customer | ||
* GCS bucket, each json file containing BatchAnnotateImagesResponse proto. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {google.cloud.vision.v1.OutputConfig} request.outputConfig | ||
* Required. The desired output location and metadata (e.g. format). | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
asyncBatchAnnotateImages(request?: protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>; | ||
@@ -124,9 +233,43 @@ asyncBatchAnnotateImages(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateImagesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
checkAsyncBatchAnnotateImagesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1.OperationMetadata>>; | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
asyncBatchAnnotateFiles(request?: protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>; | ||
@@ -144,7 +287,4 @@ asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -151,0 +291,0 @@ checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1.OperationMetadata>>; |
@@ -255,32 +255,2 @@ "use strict"; | ||
} | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateImages(request); | ||
*/ | ||
batchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -306,39 +276,2 @@ request = request || {}; | ||
} | ||
/** | ||
* Service that performs image detection and annotation for a batch of files. | ||
* Now only "application/pdf", "image/tiff" and "image/gif" are supported. | ||
* | ||
* This service will extract at most 5 (customers can specify which 5 in | ||
* AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each | ||
* file provided and perform detection and annotation for each image | ||
* extracted. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. The list of file annotation requests. Right now we support only | ||
* one AnnotateFileRequest in BatchAnnotateFilesRequest. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateFilesResponse]{@link google.cloud.vision.v1.BatchAnnotateFilesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateFiles(request); | ||
*/ | ||
batchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -364,45 +297,2 @@ request = request || {}; | ||
} | ||
/** | ||
* Run asynchronous image detection and annotation for a list of images. | ||
* | ||
* Progress and results can be retrieved through the | ||
* `google.longrunning.Operations` interface. | ||
* `Operation.metadata` contains `OperationMetadata` (metadata). | ||
* `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). | ||
* | ||
* This service will write image annotation outputs to json files in customer | ||
* GCS bucket, each json file containing BatchAnnotateImagesResponse proto. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {google.cloud.vision.v1.OutputConfig} request.outputConfig | ||
* Required. The desired output location and metadata (e.g. format). | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateImages(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -437,7 +327,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateImagesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
@@ -450,40 +337,2 @@ async checkAsyncBatchAnnotateImagesProgress(name) { | ||
} | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {string} request.parent | ||
* Optional. Target project and location to make a call. | ||
* | ||
* Format: `projects/{project-id}/locations/{location-id}`. | ||
* | ||
* If no parent is specified, a region will be chosen automatically. | ||
* | ||
* Supported location-ids: | ||
* `us`: USA country only, | ||
* `asia`: East asia areas, like Japan, Taiwan, | ||
* `eu`: The European Union. | ||
* | ||
* Example: `projects/project-A/locations/eu`. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateFiles(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -518,7 +367,4 @@ request = request || {}; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -525,0 +371,0 @@ async checkAsyncBatchAnnotateFilesProgress(name) { |
@@ -101,2 +101,19 @@ import * as gax from 'google-gax'; | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1p1beta1/image_annotator.batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p1beta1_generated_ImageAnnotator_BatchAnnotateImages_async | ||
*/ | ||
batchAnnotateImages(request?: protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>; | ||
@@ -103,0 +120,0 @@ batchAnnotateImages(request: protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p1beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; |
@@ -223,19 +223,2 @@ "use strict"; | ||
} | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p1beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateImages(request); | ||
*/ | ||
batchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -252,2 +235,4 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
@@ -254,0 +239,0 @@ return this.innerApiCalls.batchAnnotateImages(request, options, callback); |
@@ -102,5 +102,46 @@ import * as gax from 'google-gax'; | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1p2beta1/image_annotator.batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p2beta1_generated_ImageAnnotator_BatchAnnotateImages_async | ||
*/ | ||
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]>; | ||
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; | ||
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; | ||
/** | ||
* 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1p2beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p2beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
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]>; | ||
@@ -118,7 +159,4 @@ 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; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p2beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p2beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -125,0 +163,0 @@ checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p2beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p2beta1.OperationMetadata>>; |
@@ -242,19 +242,2 @@ "use strict"; | ||
} | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p2beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateImages(request); | ||
*/ | ||
batchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -271,30 +254,7 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
return this.innerApiCalls.batchAnnotateImages(request, options, callback); | ||
} | ||
/** | ||
* 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateFiles(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -311,2 +271,4 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
@@ -324,7 +286,4 @@ return this.innerApiCalls.asyncBatchAnnotateFiles(request, options, callback); | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p2beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p2beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -331,0 +290,0 @@ async checkAsyncBatchAnnotateFilesProgress(name) { |
@@ -105,5 +105,46 @@ import * as gax from 'google-gax'; | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p3beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1p3beta1/image_annotator.batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p3beta1_generated_ImageAnnotator_BatchAnnotateImages_async | ||
*/ | ||
batchAnnotateImages(request?: protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1p3beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p3beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
asyncBatchAnnotateFiles(request?: protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>; | ||
@@ -121,7 +162,4 @@ asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p3beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p3beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -128,0 +166,0 @@ checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.OperationMetadata>>; |
@@ -250,19 +250,2 @@ "use strict"; | ||
} | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p3beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateImages(request); | ||
*/ | ||
batchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -279,30 +262,7 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
return this.innerApiCalls.batchAnnotateImages(request, options, callback); | ||
} | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateFiles(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -319,2 +279,4 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
@@ -332,7 +294,4 @@ return this.innerApiCalls.asyncBatchAnnotateFiles(request, options, callback); | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p3beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p3beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -339,0 +298,0 @@ async checkAsyncBatchAnnotateFilesProgress(name) { |
@@ -105,8 +105,78 @@ import * as gax from 'google-gax'; | ||
getProjectId(callback: Callback<string, undefined, undefined>): void; | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p4beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_BatchAnnotateImages_async | ||
*/ | ||
batchAnnotateImages(request?: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]>; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
batchAnnotateImages(request: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p4beta1.IBatchAnnotateImagesRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Service that performs image detection and annotation for a batch of files. | ||
* Now only "application/pdf", "image/tiff" and "image/gif" are supported. | ||
* | ||
* This service will extract at most 5 (customers can specify which 5 in | ||
* AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each | ||
* file provided and perform detection and annotation for each image | ||
* extracted. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. The list of file annotation requests. Right now we support only | ||
* one AnnotateFileRequest in BatchAnnotateFilesRequest. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateFilesResponse]{@link google.cloud.vision.v1p4beta1.BatchAnnotateFilesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_BatchAnnotateFiles_async | ||
*/ | ||
batchAnnotateFiles(request?: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesResponse, (protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest | undefined), {} | undefined]>; | ||
batchAnnotateFiles(request: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void; | ||
batchAnnotateFiles(request: protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest, callback: Callback<protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p4beta1.IBatchAnnotateFilesRequest | null | undefined, {} | null | undefined>): void; | ||
/** | ||
* Run asynchronous image detection and annotation for a list of images. | ||
* | ||
* Progress and results can be retrieved through the | ||
* `google.longrunning.Operations` interface. | ||
* `Operation.metadata` contains `OperationMetadata` (metadata). | ||
* `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). | ||
* | ||
* This service will write image annotation outputs to json files in customer | ||
* GCS bucket, each json file containing BatchAnnotateImagesResponse proto. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {google.cloud.vision.v1p4beta1.OutputConfig} request.outputConfig | ||
* Required. The desired output location and metadata (e.g. format). | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
asyncBatchAnnotateImages(request?: protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateImagesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p4beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>; | ||
@@ -124,9 +194,30 @@ asyncBatchAnnotateImages(request: protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateImagesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p4beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateImagesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
checkAsyncBatchAnnotateImagesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p4beta1.AsyncBatchAnnotateImagesResponse, protos.google.cloud.vision.v1p4beta1.OperationMetadata>>; | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
asyncBatchAnnotateFiles(request?: protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateFilesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p4beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>; | ||
@@ -144,7 +235,4 @@ asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateFilesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p4beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p4beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -151,0 +239,0 @@ checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p4beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p4beta1.OperationMetadata>>; |
@@ -255,19 +255,2 @@ "use strict"; | ||
} | ||
/** | ||
* Run image detection and annotation for a batch of images. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateImagesResponse]{@link google.cloud.vision.v1p4beta1.BatchAnnotateImagesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateImages(request); | ||
*/ | ||
batchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -284,29 +267,7 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
return this.innerApiCalls.batchAnnotateImages(request, options, callback); | ||
} | ||
/** | ||
* Service that performs image detection and annotation for a batch of files. | ||
* Now only "application/pdf", "image/tiff" and "image/gif" are supported. | ||
* | ||
* This service will extract at most 5 (customers can specify which 5 in | ||
* AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each | ||
* file provided and perform detection and annotation for each image | ||
* extracted. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. The list of file annotation requests. Right now we support only | ||
* one AnnotateFileRequest in BatchAnnotateFilesRequest. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {Promise} - The promise which resolves to an array. | ||
* The first element of the array is an object representing [BatchAnnotateFilesResponse]{@link google.cloud.vision.v1p4beta1.BatchAnnotateFilesResponse}. | ||
* Please see the | ||
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) | ||
* for more details and examples. | ||
* @example | ||
* const [response] = await client.batchAnnotateFiles(request); | ||
*/ | ||
batchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -323,35 +284,7 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
return this.innerApiCalls.batchAnnotateFiles(request, options, callback); | ||
} | ||
/** | ||
* Run asynchronous image detection and annotation for a list of images. | ||
* | ||
* Progress and results can be retrieved through the | ||
* `google.longrunning.Operations` interface. | ||
* `Operation.metadata` contains `OperationMetadata` (metadata). | ||
* `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). | ||
* | ||
* This service will write image annotation outputs to json files in customer | ||
* GCS bucket, each json file containing BatchAnnotateImagesResponse proto. | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual image annotation requests for this batch. | ||
* @param {google.cloud.vision.v1p4beta1.OutputConfig} request.outputConfig | ||
* Required. The desired output location and metadata (e.g. format). | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateImages(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateImages(request, optionsOrCallback, callback) { | ||
@@ -368,2 +301,4 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
@@ -381,7 +316,4 @@ return this.innerApiCalls.asyncBatchAnnotateImages(request, options, callback); | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateImagesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_images.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateImages_async | ||
*/ | ||
@@ -394,27 +326,2 @@ async checkAsyncBatchAnnotateImagesProgress(name) { | ||
} | ||
/** | ||
* Run asynchronous image detection and annotation for a list of generic | ||
* files, such as PDF files, 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). | ||
* | ||
* @param {Object} request | ||
* The request object that will be sent. | ||
* @param {number[]} request.requests | ||
* Required. Individual async file annotation requests for this batch. | ||
* @param {object} [options] | ||
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. | ||
* @returns {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 | ||
* const [operation] = await client.asyncBatchAnnotateFiles(request); | ||
* const [response] = await operation.promise(); | ||
*/ | ||
asyncBatchAnnotateFiles(request, optionsOrCallback, callback) { | ||
@@ -431,2 +338,4 @@ request = request || {}; | ||
options = options || {}; | ||
options.otherArgs = options.otherArgs || {}; | ||
options.otherArgs.headers = options.otherArgs.headers || {}; | ||
this.initialize(); | ||
@@ -444,7 +353,4 @@ return this.innerApiCalls.asyncBatchAnnotateFiles(request, options, callback); | ||
* for more details and examples. | ||
* @example | ||
* const decodedOperation = await checkAsyncBatchAnnotateFilesProgress(name); | ||
* console.log(decodedOperation.result); | ||
* console.log(decodedOperation.done); | ||
* console.log(decodedOperation.metadata); | ||
* @example <caption>include:samples/generated/v1p4beta1/image_annotator.async_batch_annotate_files.js</caption> | ||
* region_tag:vision_v1p4beta1_generated_ImageAnnotator_AsyncBatchAnnotateFiles_async | ||
*/ | ||
@@ -451,0 +357,0 @@ async checkAsyncBatchAnnotateFilesProgress(name) { |
@@ -7,2 +7,10 @@ # Changelog | ||
### [2.4.1](https://www.github.com/googleapis/nodejs-vision/compare/v2.4.0...v2.4.1) (2021-12-14) | ||
### Bug Fixes | ||
* comment about gcsUri ([#967](https://www.github.com/googleapis/nodejs-vision/issues/967)) ([abc4044](https://www.github.com/googleapis/nodejs-vision/commit/abc4044dc972746292dad107009bc67223b88f86)) | ||
* **deps:** update dependency redis to v4 ([#966](https://www.github.com/googleapis/nodejs-vision/issues/966)) ([1584e4e](https://www.github.com/googleapis/nodejs-vision/commit/1584e4e65f56f66a968472f6b7dabf23393dc3f4)) | ||
## [2.4.0](https://www.github.com/googleapis/nodejs-vision/compare/v2.3.8...v2.4.0) (2021-09-09) | ||
@@ -9,0 +17,0 @@ |
{ | ||
"name": "@google-cloud/vision", | ||
"description": "Google Cloud Vision API client for Node.js", | ||
"version": "2.4.0", | ||
"version": "2.4.1", | ||
"license": "Apache-2.0", | ||
@@ -55,3 +55,3 @@ "author": "Google Inc", | ||
"@types/mocha": "^8.0.0", | ||
"@types/node": "^14.0.0", | ||
"@types/node": "^16.0.0", | ||
"@types/sinon": "^10.0.0", | ||
@@ -69,3 +69,3 @@ "@types/uuid": "^8.0.0", | ||
"pack-n-play": "^1.0.0-2", | ||
"sinon": "^11.0.0", | ||
"sinon": "^12.0.0", | ||
"ts-loader": "^9.0.0", | ||
@@ -72,0 +72,0 @@ "typescript": "^3.8.3", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
11237384
61894