Google Cloud Vision v1 API - Class ImageAnnotatorClientImpl (3.7.0)

public sealed class ImageAnnotatorClientImpl : ImageAnnotatorClient

Reference documentation and code samples for the Google Cloud Vision v1 API class ImageAnnotatorClientImpl.

ImageAnnotator client wrapper implementation, for convenient use.

Inheritance

object > ImageAnnotatorClient > ImageAnnotatorClientImpl

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Remarks

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.

Constructors

ImageAnnotatorClientImpl(ImageAnnotatorClient, ImageAnnotatorSettings, ILogger)

public ImageAnnotatorClientImpl(ImageAnnotator.ImageAnnotatorClient grpcClient, ImageAnnotatorSettings settings, ILogger logger)

Constructs a client wrapper for the ImageAnnotator service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ImageAnnotatorImageAnnotatorClient

The underlying gRPC client.
settings ImageAnnotatorSettings

The base ImageAnnotatorSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

AsyncBatchAnnotateFilesOperationsClient

public override OperationsClient AsyncBatchAnnotateFilesOperationsClient { get; }

The long-running operations client for AsyncBatchAnnotateFiles.

Property Value
Type Description
OperationsClient
Overrides

AsyncBatchAnnotateImagesOperationsClient

public override OperationsClient AsyncBatchAnnotateImagesOperationsClient { get; }

The long-running operations client for AsyncBatchAnnotateImages.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ImageAnnotator.ImageAnnotatorClient GrpcClient { get; }

The underlying gRPC ImageAnnotator client

Property Value
Type Description
ImageAnnotatorImageAnnotatorClient
Overrides

Methods

AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest, CallSettings)

public override Operation<AsyncBatchAnnotateFilesResponse, OperationMetadata> AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest request, CallSettings callSettings = null)

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).

Parameters
Name Description
request AsyncBatchAnnotateFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAsyncBatchAnnotateFilesResponseOperationMetadata

The RPC response.
Overrides

AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest, CallSettings)

public override Task<Operation<AsyncBatchAnnotateFilesResponse, OperationMetadata>> AsyncBatchAnnotateFilesAsync(AsyncBatchAnnotateFilesRequest request, CallSettings callSettings = null)

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).

Parameters
Name Description
request AsyncBatchAnnotateFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAsyncBatchAnnotateFilesResponseOperationMetadata

A Task containing the RPC response.
Overrides

AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest, CallSettings)

public override Operation<AsyncBatchAnnotateImagesResponse, OperationMetadata> AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request AsyncBatchAnnotateImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAsyncBatchAnnotateImagesResponseOperationMetadata

The RPC response.
Overrides

AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest, CallSettings)

public override Task<Operation<AsyncBatchAnnotateImagesResponse, OperationMetadata>> AsyncBatchAnnotateImagesAsync(AsyncBatchAnnotateImagesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request AsyncBatchAnnotateImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAsyncBatchAnnotateImagesResponseOperationMetadata

A Task containing the RPC response.
Overrides

BatchAnnotateFiles(BatchAnnotateFilesRequest, CallSettings)

public override BatchAnnotateFilesResponse BatchAnnotateFiles(BatchAnnotateFilesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchAnnotateFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchAnnotateFilesResponse

The RPC response.
Overrides

BatchAnnotateFilesAsync(BatchAnnotateFilesRequest, CallSettings)

public override Task<BatchAnnotateFilesResponse> BatchAnnotateFilesAsync(BatchAnnotateFilesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request BatchAnnotateFilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchAnnotateFilesResponse

A Task containing the RPC response.
Overrides

BatchAnnotateImages(BatchAnnotateImagesRequest, CallSettings)

public override BatchAnnotateImagesResponse BatchAnnotateImages(BatchAnnotateImagesRequest request, CallSettings callSettings = null)

Run image detection and annotation for a batch of images.

Parameters
Name Description
request BatchAnnotateImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
BatchAnnotateImagesResponse

The RPC response.
Overrides

BatchAnnotateImagesAsync(BatchAnnotateImagesRequest, CallSettings)

public override Task<BatchAnnotateImagesResponse> BatchAnnotateImagesAsync(BatchAnnotateImagesRequest request, CallSettings callSettings = null)

Run image detection and annotation for a batch of images.

Parameters
Name Description
request BatchAnnotateImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBatchAnnotateImagesResponse

A Task containing the RPC response.
Overrides