Skip to content

Commit

Permalink
feat: image annotation batching (#375)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation @callmehiphop
yoshi-automation authored and callmehiphop committed May 9, 2019
1 parent e25558b commit 6d20071
Show file tree
Hide file tree
Showing 23 changed files with 1,498 additions and 938 deletions.
2 changes: 1 addition & 1 deletion packages/google-cloud-vision/protos/google/cloud/vision/v1/geometry.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
173 changes: 140 additions & 33 deletions packages/google-cloud-vision/protos/google/cloud/vision/v1/image_annotator.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -49,6 +49,38 @@ service ImageAnnotator {
};
}

// 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.
rpc BatchAnnotateFiles(BatchAnnotateFilesRequest)
returns (BatchAnnotateFilesResponse) {
option (google.api.http) = {
post: "/v1/files:annotate"
body: "*"
};
}

// 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.
rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/images:asyncBatchAnnotate"
body: "*"
};
}

// 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
Expand Down Expand Up @@ -128,6 +160,28 @@ message Feature {
string model = 3;
}

// A bucketized representation of likelihood, which is intended to give clients
// highly stable results across model upgrades.
enum Likelihood {
// Unknown likelihood.
UNKNOWN = 0;

// It is very unlikely that the image belongs to the specified vertical.
VERY_UNLIKELY = 1;

// It is unlikely that the image belongs to the specified vertical.
UNLIKELY = 2;

// It is possible that the image belongs to the specified vertical.
POSSIBLE = 3;

// It is likely that the image belongs to the specified vertical.
LIKELY = 4;

// It is very likely that the image belongs to the specified vertical.
VERY_LIKELY = 5;
}

// External image source (Google Cloud Storage or web URL image location).
message ImageSource {
// **Use `image_uri` instead.**
Expand Down Expand Up @@ -294,7 +348,7 @@ message FaceAnnotation {
}

// The bounding polygon around the face. The coordinates of the bounding box
// are in the original image's scale, as returned in `ImageParams`.
// are in the original image's scale.
// The bounding box is computed to "frame" the face in accordance with human
// expectations. It is based on the landmarker results.
// Note that one or more x and/or y coordinates may not be generated in the
Expand Down Expand Up @@ -505,7 +559,7 @@ message ImageProperties {
// Single crop hint that is used to generate a new crop when serving an image.
message CropHint {
// The bounding polygon for the crop region. The coordinates of the bounding
// box are in the original image's scale, as returned in `ImageParams`.
// box are in the original image's scale.
BoundingPoly bounding_poly = 1;

// Confidence of this being a salient region. Range [0, 1].
Expand Down Expand Up @@ -565,7 +619,7 @@ message ImageContext {
}

// Request for performing Google Cloud Vision API tasks over a user-provided
// image, with user-requested features.
// image, with user-requested features, and with context information.
message AnnotateImageRequest {
// The image to be processed.
Image image = 1;
Expand Down Expand Up @@ -648,6 +702,9 @@ message AnnotateFileResponse {

// Individual responses to images found within the file.
repeated AnnotateImageResponse responses = 2;

// This field gives the total number of pages in the file.
int32 total_pages = 3;
}

// Multiple image annotation requests are batched into a single service call.
Expand All @@ -662,6 +719,48 @@ message BatchAnnotateImagesResponse {
repeated AnnotateImageResponse responses = 1;
}

// A request to annotate one single file, e.g. a PDF, TIFF or GIF file.
message AnnotateFileRequest {
// Required. Information about the input file.
InputConfig input_config = 1;

// Required. Requested features.
repeated Feature features = 2;

// Additional context that may accompany the image(s) in the file.
ImageContext image_context = 3;

// Pages of the file to perform image annotation.
//
// Pages starts from 1, we assume the first page of the file is page 1.
// At most 5 pages are supported per request. Pages can be negative.
//
// Page 1 means the first page.
// Page 2 means the second page.
// Page -1 means the last page.
// Page -2 means the second to the last page.
//
// If the file is GIF instead of PDF or TIFF, page refers to GIF frames.
//
// If this field is empty, by default the service performs image annotation
// for the first 5 pages of the file.
repeated int32 pages = 4;
}

// A list of requests to annotate files using the BatchAnnotateFiles API.
message BatchAnnotateFilesRequest {
// The list of file annotation requests. Right now we support only one
// AnnotateFileRequest in BatchAnnotateFilesRequest.
repeated AnnotateFileRequest requests = 1;
}

// A list of file annotation responses.
message BatchAnnotateFilesResponse {
// The list of file annotation responses, each response corresponding to each
// AnnotateFileRequest in BatchAnnotateFilesRequest.
repeated AnnotateFileResponse responses = 1;
}

// An offline file annotation request.
message AsyncAnnotateFileRequest {
// Required. Information about the input file.
Expand All @@ -683,6 +782,21 @@ message AsyncAnnotateFileResponse {
OutputConfig output_config = 1;
}

// Request for async image annotation for a list of images.
message AsyncBatchAnnotateImagesRequest {
// Individual image annotation requests for this batch.
repeated AnnotateImageRequest requests = 1;

// Required. The desired output location and metadata (e.g. format).
OutputConfig output_config = 2;
}

// Response to an async batch image annotation request.
message AsyncBatchAnnotateImagesResponse {
// The output location and metadata from AsyncBatchAnnotateImagesRequest.
OutputConfig output_config = 1;
}

// Multiple async file annotation requests are batched into a single service
// call.
message AsyncBatchAnnotateFilesRequest {
Expand All @@ -702,6 +816,14 @@ message InputConfig {
// The Google Cloud Storage location to read the input from.
GcsSource gcs_source = 1;

// File content, represented as a stream of bytes.
// Note: As with all `bytes` fields, protobuffers use a pure binary
// representation, whereas JSON representations use base64.
//
// Currently, this field only works for BatchAnnotateFiles requests. It does
// not work for AsyncBatchAnnotateFiles requests.
bytes content = 3;

// The type of the file. Currently only "application/pdf" and "image/tiff"
// are supported. Wildcards are not supported.
string mime_type = 2;
Expand Down Expand Up @@ -735,16 +857,23 @@ message GcsSource {

// The Google Cloud Storage location where the output will be written to.
message GcsDestination {
// Google Cloud Storage URI where the results will be stored. Results will
// be in JSON format and preceded by its corresponding input URI. This field
// can either represent a single file, or a prefix for multiple outputs.
// Prefixes must end in a `/`.
// Google Cloud Storage URI prefix where the results will be stored. Results
// will be in JSON format and preceded by its corresponding input URI prefix.
// This field can either represent a gcs file prefix or gcs directory. In
// either case, the uri should be unique because in order to get all of the
// output files, you will need to do a wildcard gcs search on the uri prefix
// you provide.
//
// Examples:
//
// * File: gs://bucket-name/filename.json
// * Prefix: gs://bucket-name/prefix/here/
// * File: gs://bucket-name/prefix/here
// * File Prefix: gs://bucket-name/here/filenameprefix The output files
// will be created in gs://bucket-name/here/ and the names of the
// output files will begin with "filenameprefix".
//
// * Directory Prefix: gs://bucket-name/some/location/ The output files
// will be created in gs://bucket-name/some/location/ and the names of the
// output files could be anything because there was no filename prefix
// specified.
//
// If multiple outputs, each response is still AnnotateFileResponse, each of
// which contains some subset of the full list of AnnotateImageResponse.
Expand Down Expand Up @@ -782,25 +911,3 @@ message OperationMetadata {
// The time when the operation result was last updated.
google.protobuf.Timestamp update_time = 6;
}

// A bucketized representation of likelihood, which is intended to give clients
// highly stable results across model upgrades.
enum Likelihood {
// Unknown likelihood.
UNKNOWN = 0;

// It is very unlikely that the image belongs to the specified vertical.
VERY_UNLIKELY = 1;

// It is unlikely that the image belongs to the specified vertical.
UNLIKELY = 2;

// It is possible that the image belongs to the specified vertical.
POSSIBLE = 3;

// It is likely that the image belongs to the specified vertical.
LIKELY = 4;

// It is very likely that the image belongs to the specified vertical.
VERY_LIKELY = 5;
}
13 changes: 8 additions & 5 deletions packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -49,10 +49,12 @@ message ProductSearchParams {

// The filtering expression. This can be used to restrict search results based
// on Product labels. We currently support an AND of OR of key-value
// expressions, where each expression within an OR must have the same key.
// expressions, where each expression within an OR must have the same key. An
// '=' should be used to connect the key and value.
//
// For example, "(color = red OR color = blue) AND brand = Google" is
// acceptable, but not "(color = red OR brand = Google)" or "color: red".
// acceptable, but "(color = red OR brand = Google)" is not acceptable.
// "color: red" is not acceptable because it uses a ':' instead of an '='.
string filter = 8;
}

Expand Down Expand Up @@ -82,8 +84,9 @@ message ProductSearchResults {
repeated Result results = 2;
}

// Timestamp of the index which provided these results. Changes made after
// this time are not reflected in the current results.
// Timestamp of the index which provided these results. Products added to the
// product set and products removed from the product set after this time are
// not reflected in the current results.
google.protobuf.Timestamp index_time = 2;

// List of results, one for each product match.
Expand Down
21 changes: 3 additions & 18 deletions packages/google-cloud-vision/protos/google/cloud/vision/v1/product_search_service.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -105,10 +105,6 @@ service ProductSearch {
// ProductSet are not deleted.
//
// The actual image files are not deleted from Google Cloud Storage.
//
// Possible errors:
//
// * Returns NOT_FOUND if the ProductSet does not exist.
rpc DeleteProductSet(DeleteProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down Expand Up @@ -180,10 +176,6 @@ service ProductSearch {
// Metadata of the product and all its images will be deleted right away, but
// search queries against ProductSets containing the product may still work
// until all related caches are refreshed.
//
// Possible errors:
//
// * Returns NOT_FOUND if the product does not exist.
rpc DeleteProduct(DeleteProductRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/products/*}"
Expand Down Expand Up @@ -224,10 +216,6 @@ service ProductSearch {
// caches are refreshed.
//
// The actual image files are not deleted from Google Cloud Storage.
//
// Possible errors:
//
// * Returns NOT_FOUND if the reference image does not exist.
rpc DeleteReferenceImage(DeleteReferenceImageRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down Expand Up @@ -277,10 +265,6 @@ service ProductSearch {
}

// Removes a Product from the specified ProductSet.
//
// Possible errors:
//
// * Returns NOT_FOUND If the Product is not found under the ProductSet.
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
Expand Down Expand Up @@ -388,7 +372,8 @@ message ProductSet {

// Output only. The time at which this ProductSet was last indexed. Query
// results will reflect all updates before this time. If this ProductSet has
// never been indexed, this field is 0.
// never been indexed, this timestamp is the default value
// "1970-01-01T00:00:00Z".
//
// This field is ignored when creating a ProductSet.
google.protobuf.Timestamp index_time = 3;
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-vision/protos/google/cloud/vision/v1/text_annotation.proto
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit 6d20071

Please sign in to comment.