Class ImageAnnotatorClient (2.30.0)

Version 2.30.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ImageAnnotatorClient(ImageAnnotatorClient const &)

Copy and move support

Parameter
Name	Description
	ImageAnnotatorClient const &

ImageAnnotatorClient(ImageAnnotatorClient &&)

Copy and move support

Parameter
Name	Description
	ImageAnnotatorClient &&

ImageAnnotatorClient(std::shared_ptr< ImageAnnotatorConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ImageAnnotatorConnection >
opts	Options

Operators

operator=(ImageAnnotatorClient const &)

Copy and move support

Parameter
Name	Description
	ImageAnnotatorClient const &

Returns
Type	Description
ImageAnnotatorClient &

operator=(ImageAnnotatorClient &&)

Copy and move support

Parameter
Name	Description
	ImageAnnotatorClient &&

Returns
Type	Description
ImageAnnotatorClient &

Functions

BatchAnnotateImages(std::vector< google::cloud::vision::v1::AnnotateImageRequest > const &, Options)

Run image detection and annotation for a batch of images.

Parameters
Name	Description
requests	std::vector< google::cloud::vision::v1::AnnotateImageRequest > const & Required. Individual image annotation requests for this batch.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::vision::v1::BatchAnnotateImagesResponse >	the result of the RPC. The response message type (google.cloud.vision.v1.BatchAnnotateImagesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchAnnotateImages(google::cloud::vision::v1::BatchAnnotateImagesRequest const &, Options)

Run image detection and annotation for a batch of images.

Parameters
Name	Description
request	google::cloud::vision::v1::BatchAnnotateImagesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vision.v1.BatchAnnotateImagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::vision::v1::BatchAnnotateImagesResponse >	the result of the RPC. The response message type (google.cloud.vision.v1.BatchAnnotateImagesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchAnnotateFiles(std::vector< google::cloud::vision::v1::AnnotateFileRequest > const &, Options)

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
requests	std::vector< google::cloud::vision::v1::AnnotateFileRequest > const & Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::vision::v1::BatchAnnotateFilesResponse >	the result of the RPC. The response message type (google.cloud.vision.v1.BatchAnnotateFilesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchAnnotateFiles(google::cloud::vision::v1::BatchAnnotateFilesRequest const &, Options)

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	google::cloud::vision::v1::BatchAnnotateFilesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vision.v1.BatchAnnotateFilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::vision::v1::BatchAnnotateFilesResponse >	the result of the RPC. The response message type (google.cloud.vision.v1.BatchAnnotateFilesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AsyncBatchAnnotateImages(std::vector< google::cloud::vision::v1::AnnotateImageRequest > const &, google::cloud::vision::v1::OutputConfig const &, Options)

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
requests	std::vector< google::cloud::vision::v1::AnnotateImageRequest > const & Required. Individual image annotation requests for this batch.
output_config	google::cloud::vision::v1::OutputConfig const & Required. The desired output location and metadata (e.g. format).
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateImagesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AsyncBatchAnnotateImages(NoAwaitTag, std::vector< google::cloud::vision::v1::AnnotateImageRequest > const &, google::cloud::vision::v1::OutputConfig const &, Options)

Run asynchronous image detection and annotation for a list of images.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
requests	std::vector< google::cloud::vision::v1::AnnotateImageRequest > const &
output_config	google::cloud::vision::v1::OutputConfig const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

AsyncBatchAnnotateImages(google::cloud::vision::v1::AsyncBatchAnnotateImagesRequest const &, Options)

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	google::cloud::vision::v1::AsyncBatchAnnotateImagesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateImagesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AsyncBatchAnnotateImages(NoAwaitTag, google::cloud::vision::v1::AsyncBatchAnnotateImagesRequest const &, Options)

Run asynchronous image detection and annotation for a list of images.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::vision::v1::AsyncBatchAnnotateImagesRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

AsyncBatchAnnotateImages(google::longrunning::Operation const &, Options)

Run asynchronous image detection and annotation for a list of images.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateImagesResponse > >

AsyncBatchAnnotateFiles(std::vector< google::cloud::vision::v1::AsyncAnnotateFileRequest > const &, Options)

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
requests	std::vector< google::cloud::vision::v1::AsyncAnnotateFileRequest > const & Required. Individual async file annotation requests for this batch.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateFilesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AsyncBatchAnnotateFiles(NoAwaitTag, std::vector< google::cloud::vision::v1::AsyncAnnotateFileRequest > const &, Options)

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.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
requests	std::vector< google::cloud::vision::v1::AsyncAnnotateFileRequest > const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

AsyncBatchAnnotateFiles(google::cloud::vision::v1::AsyncBatchAnnotateFilesRequest const &, Options)

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	google::cloud::vision::v1::AsyncBatchAnnotateFilesRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateFilesResponse > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AsyncBatchAnnotateFiles(NoAwaitTag, google::cloud::vision::v1::AsyncBatchAnnotateFilesRequest const &, Options)

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.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::vision::v1::AsyncBatchAnnotateFilesRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

AsyncBatchAnnotateFiles(google::longrunning::Operation const &, Options)

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.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::vision::v1::AsyncBatchAnnotateFilesResponse > >