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