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. v1p3beta1
Package
@google-cloud/vision!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ImageAnnotatorClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
imageAnnotatorStub
imageAnnotatorStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
asyncBatchAnnotateFiles(request, options)
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]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
asyncBatchAnnotateFiles(request, options, callback)
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;
Parameters
Name | Description |
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>
|
Returns
asyncBatchAnnotateFiles(request, callback)
asyncBatchAnnotateFiles(request: protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesRequest
|
callback |
Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IAsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
batchAnnotateImages(request, options)
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]>;
Parameters
Name | Description |
request |
protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesResponse, (protos.google.cloud.vision.v1p3beta1.IBatchAnnotateImagesRequest | undefined), {} | undefined]> | |
batchAnnotateImages(request, options, callback)
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;
Parameters
Name | Description |
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>
|
Returns
batchAnnotateImages(request, callback)
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;
Parameters
Name | Description |
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>
|
Returns
checkAsyncBatchAnnotateFilesProgress(name)
checkAsyncBatchAnnotateFilesProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.OperationMetadata>>;
Check the status of the long running operation returned by asyncBatchAnnotateFiles()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.vision.v1p3beta1.AsyncBatchAnnotateFilesResponse, protos.google.cloud.vision.v1p3beta1.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.
|
close()
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<void> | {Promise} A promise that resolves when the client is closed.
|
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
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
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
matchLocationFromProductName(productName)
matchLocationFromProductName(productName: string): string | number;
Parse the location from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromProductSetName(productSetName)
matchLocationFromProductSetName(productSetName: string): string | number;
Parse the location from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromReferenceImageName(referenceImageName)
matchLocationFromReferenceImageName(referenceImageName: string): string | number;
Parse the location from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProductFromProductName(productName)
matchProductFromProductName(productName: string): string | number;
Parse the product from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product.
|
matchProductFromReferenceImageName(referenceImageName)
matchProductFromReferenceImageName(referenceImageName: string): string | number;
Parse the product from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product.
|
matchProductSetFromProductSetName(productSetName)
matchProductSetFromProductSetName(productSetName: string): string | number;
Parse the product_set from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the product_set.
|
matchProjectFromProductName(productName)
matchProjectFromProductName(productName: string): string | number;
Parse the project from Product resource.
Parameter
Name | Description |
productName |
string
A fully-qualified path representing Product resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProductSetName(productSetName)
matchProjectFromProductSetName(productSetName: string): string | number;
Parse the project from ProductSet resource.
Parameter
Name | Description |
productSetName |
string
A fully-qualified path representing ProductSet resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromReferenceImageName(referenceImageName)
matchProjectFromReferenceImageName(referenceImageName: string): string | number;
Parse the project from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchReferenceImageFromReferenceImageName(referenceImageName)
matchReferenceImageFromReferenceImageName(referenceImageName: string): string | number;
Parse the reference_image from ReferenceImage resource.
Parameter
Name | Description |
referenceImageName |
string
A fully-qualified path representing ReferenceImage resource.
|
Returns
Type | Description |
string | number | {string} A string representing the reference_image.
|
productPath(project, location, product)
productPath(project: string, location: string, product: string): string;
Return a fully-qualified product resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
product |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
productSetPath(project, location, productSet)
productSetPath(project: string, location: string, productSet: string): string;
Return a fully-qualified productSet resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
productSet |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
referenceImagePath(project, location, product, referenceImage)
referenceImagePath(project: string, location: string, product: string, referenceImage: string): string;
Return a fully-qualified referenceImage resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
product |
string
|
referenceImage |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|