Synchronize new proto/yaml changes.

PiperOrigin-RevId: 236171546
This commit is contained in:
Google APIs 2019-02-28 12:15:47 -08:00 committed by Copybara-Service
parent aee52e90e8
commit 2a18b58835
23 changed files with 161 additions and 110 deletions

View File

@ -26,7 +26,6 @@ option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// A vertex represents a 2D point in the image.
// NOTE: the vertex coordinates are in the same scale as the original image.
message Vertex {

View File

@ -36,13 +36,13 @@ option java_outer_classname = "ImageAnnotatorProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// 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.
service ImageAnnotator {
// Run image detection and annotation for a batch of images.
rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse) {
rpc BatchAnnotateImages(BatchAnnotateImagesRequest)
returns (BatchAnnotateImagesResponse) {
option (google.api.http) = {
post: "/v1/images:annotate"
body: "*"
@ -55,7 +55,8 @@ service ImageAnnotator {
// `google.longrunning.Operations` interface.
// `Operation.metadata` contains `OperationMetadata` (metadata).
// `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (google.longrunning.Operation) {
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/files:asyncBatchAnnotate"
body: "*"

View File

@ -29,14 +29,14 @@ option java_outer_classname = "ProductSearchProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// Parameters for a product search request.
message ProductSearchParams {
// The bounding polygon around the area of interest in the image.
// Optional. If it is not specified, system discretion will be applied.
BoundingPoly bounding_poly = 9;
// The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images.
// The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to
// be searched for similar images.
//
// Format is:
// `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

View File

@ -32,20 +32,21 @@ option java_outer_classname = "ProductSearchServiceProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// Manages Products and ProductSets of reference images for use in product
// search. It uses the following resource model:
//
// - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet] resources, named
// `projects/*/locations/*/productSets/*`, which acts as a way to put different
// products into groups to limit identification.
// - The API has a collection of [ProductSet][google.cloud.vision.v1.ProductSet]
// resources, named `projects/*/locations/*/productSets/*`, which acts as a way
// to put different products into groups to limit identification.
//
// In parallel,
//
// - The API has a collection of [Product][google.cloud.vision.v1.Product] resources, named
// - The API has a collection of [Product][google.cloud.vision.v1.Product]
// resources, named
// `projects/*/locations/*/products/*`
//
// - Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named
// - Each [Product][google.cloud.vision.v1.Product] has a collection of
// [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named
// `projects/*/locations/*/products/*/referenceImages/*`
service ProductSearch {
// Creates and returns a new ProductSet resource.
@ -67,7 +68,8 @@ service ProductSearch {
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
// than 1.
rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse) {
rpc ListProductSets(ListProductSetsRequest)
returns (ListProductSetsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/productSets"
};
@ -107,7 +109,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the ProductSet does not exist.
rpc DeleteProductSet(DeleteProductSetRequest) returns (google.protobuf.Empty) {
rpc DeleteProductSet(DeleteProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/productSets/*}"
};
@ -206,7 +209,8 @@ service ProductSearch {
// * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
// compatible with the parent product's product_category is detected.
// * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage) {
rpc CreateReferenceImage(CreateReferenceImageRequest)
returns (ReferenceImage) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/products/*}/referenceImages"
body: "reference_image"
@ -224,7 +228,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the reference image does not exist.
rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (google.protobuf.Empty) {
rpc DeleteReferenceImage(DeleteReferenceImageRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/products/*/referenceImages/*}"
};
@ -237,7 +242,8 @@ service ProductSearch {
// * Returns NOT_FOUND if the parent product does not exist.
// * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
// than 1.
rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse) {
rpc ListReferenceImages(ListReferenceImagesRequest)
returns (ListReferenceImagesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/products/*}/referenceImages"
};
@ -262,7 +268,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
rpc AddProductToProductSet(AddProductToProductSetRequest) returns (google.protobuf.Empty) {
rpc AddProductToProductSet(AddProductToProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/productSets/*}:addProduct"
body: "*"
@ -274,7 +281,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND If the Product is not found under the ProductSet.
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (google.protobuf.Empty) {
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/productSets/*}:removeProduct"
body: "*"
@ -288,7 +296,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse) {
rpc ListProductsInProductSet(ListProductsInProductSetRequest)
returns (ListProductsInProductSetResponse) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/productSets/*}/products"
};
@ -297,15 +306,16 @@ service ProductSearch {
// Asynchronous API that imports a list of reference images to specified
// product sets based on a list of image information.
//
// The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
// progress and results of the request.
// The [google.longrunning.Operation][google.longrunning.Operation] API can be
// used to keep track of the progress and results of the request.
// `Operation.metadata` contains `BatchOperationMetadata`. (progress)
// `Operation.response` contains `ImportProductSetsResponse`. (results)
//
// The input source of this method is a csv file on Google Cloud Storage.
// For the format of the csv file please see
// [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
rpc ImportProductSets(ImportProductSetsRequest) returns (google.longrunning.Operation) {
rpc ImportProductSets(ImportProductSetsRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/productSets:import"
body: "*"
@ -718,15 +728,17 @@ message ImportProductSetsGcsSource {
// `product-display-name` column refers to
// [display_name][google.cloud.vision.v1.Product.display_name], the
// `product-category` column refers to
// [product_category][google.cloud.vision.v1.Product.product_category], and the
// `labels` column refers to [product_labels][google.cloud.vision.v1.Product.product_labels].
// [product_category][google.cloud.vision.v1.Product.product_category], and
// the `labels` column refers to
// [product_labels][google.cloud.vision.v1.Product.product_labels].
//
// The `image-id` column is optional but must be unique if provided. If it is
// empty, the system will automatically assign a unique id to the image.
//
// The `product-display-name` column is optional. If it is empty, the system
// sets the [display_name][google.cloud.vision.v1.Product.display_name] field for the product to a
// space (" "). You can update the `display_name` later by using the API.
// sets the [display_name][google.cloud.vision.v1.Product.display_name] field
// for the product to a space (" "). You can update the `display_name` later
// by using the API.
//
// If a `Product` with the specified `product-id` already exists, then the
// system ignores the `product-display-name`, `product-category`, and `labels`
@ -781,8 +793,10 @@ message ImportProductSetsRequest {
// Response message for the `ImportProductSets` method.
//
// This message is returned by the
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response] field.
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]
// method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response]
// field.
message ImportProductSetsResponse {
// The list of reference_images that are imported successfully.
repeated ReferenceImage reference_images = 1;
@ -829,6 +843,7 @@ message BatchOperationMetadata {
google.protobuf.Timestamp submit_time = 2;
// The time when the batch request is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
google.protobuf.Timestamp end_time = 3;
}

View File

@ -27,14 +27,14 @@ option java_outer_classname = "TextAnnotationProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// TextAnnotation contains a structured representation of OCR extracted text.
// The hierarchy of an OCR extracted text structure is like this:
// TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
// Each structural component, starting from Page, may further have their own
// properties. Properties describe detected languages, breaks etc.. Please refer
// to the [TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty] message definition below for more
// detail.
// to the
// [TextAnnotation.TextProperty][google.cloud.vision.v1.TextAnnotation.TextProperty]
// message definition below for more detail.
message TextAnnotation {
// Detected language for a structural component.
message DetectedLanguage {

View File

@ -26,7 +26,6 @@ option java_outer_classname = "WebDetectionProto";
option java_package = "com.google.cloud.vision.v1";
option objc_class_prefix = "GCVN";
// Relevant information for the image from the Internet.
message WebDetection {
// Entity deduced from similar images on the Internet.

View File

@ -339,7 +339,8 @@ message Property {
// Set of detected entity features.
message EntityAnnotation {
// Opaque entity ID. Some IDs may be available in
// [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
// [Google Knowledge Graph Search
// API](https://developers.google.com/knowledge-graph/).
string mid = 1;
// The language code for the locale in which the entity textual

View File

@ -22,7 +22,6 @@ option java_multiple_files = true;
option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.vision.v1p2beta1";
// A vertex represents a 2D point in the image.
// NOTE: the vertex coordinates are in the same scale as the original image.
message Vertex {

View File

@ -32,13 +32,13 @@ option java_multiple_files = true;
option java_outer_classname = "ImageAnnotatorProto";
option java_package = "com.google.cloud.vision.v1p2beta1";
// 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.
service ImageAnnotator {
// Run image detection and annotation for a batch of images.
rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse) {
rpc BatchAnnotateImages(BatchAnnotateImagesRequest)
returns (BatchAnnotateImagesResponse) {
option (google.api.http) = {
post: "/v1p2beta1/images:annotate"
body: "*"
@ -51,7 +51,8 @@ service ImageAnnotator {
// `google.longrunning.Operations` interface.
// `Operation.metadata` contains `OperationMetadata` (metadata).
// `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (google.longrunning.Operation) {
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p2beta1/files:asyncBatchAnnotate"
body: "*"

View File

@ -25,14 +25,14 @@ option java_multiple_files = true;
option java_outer_classname = "TextAnnotationProto";
option java_package = "com.google.cloud.vision.v1p2beta1";
// TextAnnotation contains a structured representation of OCR extracted text.
// The hierarchy of an OCR extracted text structure is like this:
// TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
// Each structural component, starting from Page, may further have their own
// properties. Properties describe detected languages, breaks etc.. Please refer
// to the [TextAnnotation.TextProperty][google.cloud.vision.v1p2beta1.TextAnnotation.TextProperty] message definition below for more
// detail.
// to the
// [TextAnnotation.TextProperty][google.cloud.vision.v1p2beta1.TextAnnotation.TextProperty]
// message definition below for more detail.
message TextAnnotation {
// Detected language for a structural component.
message DetectedLanguage {

View File

@ -24,7 +24,6 @@ option java_multiple_files = true;
option java_outer_classname = "WebDetectionProto";
option java_package = "com.google.cloud.vision.v1p2beta1";
// Relevant information for the image from the Internet.
message WebDetection {
// Entity deduced from similar images on the Internet.

View File

@ -24,7 +24,6 @@ option java_multiple_files = true;
option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// A vertex represents a 2D point in the image.
// NOTE: the vertex coordinates are in the same scale as the original image.
message Vertex {

View File

@ -33,13 +33,13 @@ option java_multiple_files = true;
option java_outer_classname = "ImageAnnotatorProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// 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.
service ImageAnnotator {
// Run image detection and annotation for a batch of images.
rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse) {
rpc BatchAnnotateImages(BatchAnnotateImagesRequest)
returns (BatchAnnotateImagesResponse) {
option (google.api.http) = {
post: "/v1p3beta1/images:annotate"
body: "*"
@ -52,7 +52,8 @@ service ImageAnnotator {
// `google.longrunning.Operations` interface.
// `Operation.metadata` contains `OperationMetadata` (metadata).
// `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (google.longrunning.Operation) {
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p3beta1/files:asyncBatchAnnotate"
body: "*"
@ -624,7 +625,8 @@ message AnnotateImageResponse {
WebDetection web_detection = 13;
// If present, product search has completed successfully.
google.cloud.vision.v1p3beta1.ProductSearchResults product_search_results = 14;
google.cloud.vision.v1p3beta1.ProductSearchResults product_search_results =
14;
// If set, represents the error message for the operation.
// Note that filled-in image annotations are guaranteed to be
@ -691,7 +693,7 @@ message AsyncBatchAnnotateFilesResponse {
// The list of file annotation responses, one for each request in
// AsyncBatchAnnotateFilesRequest.
repeated AsyncAnnotateFileResponse responses = 1;
};
}
// The desired input location and metadata.
message InputConfig {

View File

@ -27,7 +27,6 @@ option java_multiple_files = true;
option java_outer_classname = "ProductSearchProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// Parameters for a product search request.
message ProductSearchParams {
// The resource name of the catalog to search.
@ -59,7 +58,9 @@ message ProductSearchParams {
// Optional. Defaults to `BASIC`.
ProductSearchResultsView view = 4;
// The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
// The resource name of a
// [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for
// similar images.
//
// Format is:
// `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

View File

@ -30,20 +30,23 @@ option java_multiple_files = true;
option java_outer_classname = "ProductSearchServiceProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// Manages Products and ProductSets of reference images for use in product
// search. It uses the following resource model:
//
// - The API has a collection of [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] resources, named
// - The API has a collection of
// [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] resources, named
// `projects/*/locations/*/productSets/*`, which acts as a way to put different
// products into groups to limit identification.
//
// In parallel,
//
// - The API has a collection of [Product][google.cloud.vision.v1p3beta1.Product] resources, named
// - The API has a collection of
// [Product][google.cloud.vision.v1p3beta1.Product] resources, named
// `projects/*/locations/*/products/*`
//
// - Each [Product][google.cloud.vision.v1p3beta1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1p3beta1.ReferenceImage] resources, named
// - Each [Product][google.cloud.vision.v1p3beta1.Product] has a collection of
// [ReferenceImage][google.cloud.vision.v1p3beta1.ReferenceImage] resources,
// named
// `projects/*/locations/*/products/*/referenceImages/*`
service ProductSearch {
// Creates and returns a new ProductSet resource.
@ -65,7 +68,8 @@ service ProductSearch {
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
// than 1.
rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse) {
rpc ListProductSets(ListProductSetsRequest)
returns (ListProductSetsResponse) {
option (google.api.http) = {
get: "/v1p3beta1/{parent=projects/*/locations/*}/productSets"
};
@ -105,7 +109,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the ProductSet does not exist.
rpc DeleteProductSet(DeleteProductSetRequest) returns (google.protobuf.Empty) {
rpc DeleteProductSet(DeleteProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1p3beta1/{name=projects/*/locations/*/productSets/*}"
};
@ -203,7 +208,8 @@ service ProductSearch {
// * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
// compatible with the parent product's product_category is detected.
// * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage) {
rpc CreateReferenceImage(CreateReferenceImageRequest)
returns (ReferenceImage) {
option (google.api.http) = {
post: "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages"
body: "reference_image"
@ -221,7 +227,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the reference image does not exist.
rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (google.protobuf.Empty) {
rpc DeleteReferenceImage(DeleteReferenceImageRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}"
};
@ -234,7 +241,8 @@ service ProductSearch {
// * Returns NOT_FOUND if the parent product does not exist.
// * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
// than 1.
rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse) {
rpc ListReferenceImages(ListReferenceImagesRequest)
returns (ListReferenceImagesResponse) {
option (google.api.http) = {
get: "/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages"
};
@ -259,7 +267,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
rpc AddProductToProductSet(AddProductToProductSetRequest) returns (google.protobuf.Empty) {
rpc AddProductToProductSet(AddProductToProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:addProduct"
body: "*"
@ -271,7 +280,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND If the Product is not found under the ProductSet.
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (google.protobuf.Empty) {
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1p3beta1/{name=projects/*/locations/*/productSets/*}:removeProduct"
body: "*"
@ -285,7 +295,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse) {
rpc ListProductsInProductSet(ListProductsInProductSetRequest)
returns (ListProductsInProductSetResponse) {
option (google.api.http) = {
get: "/v1p3beta1/{name=projects/*/locations/*/productSets/*}/products"
};
@ -294,15 +305,16 @@ service ProductSearch {
// Asynchronous API that imports a list of reference images to specified
// product sets based on a list of image information.
//
// The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
// progress and results of the request.
// The [google.longrunning.Operation][google.longrunning.Operation] API can be
// used to keep track of the progress and results of the request.
// `Operation.metadata` contains `BatchOperationMetadata`. (progress)
// `Operation.response` contains `ImportProductSetsResponse`. (results)
//
// The input source of this method is a csv file on Google Cloud Storage.
// For the format of the csv file please see
// [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1p3beta1.ImportProductSetsGcsSource.csv_file_uri].
rpc ImportProductSets(ImportProductSetsRequest) returns (google.longrunning.Operation) {
rpc ImportProductSets(ImportProductSetsRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p3beta1/{parent=projects/*/locations/*}/productSets:import"
body: "*"
@ -721,9 +733,11 @@ message ImportProductSetsGcsSource {
// product_display_name, product_category and labels are ignored.
//
// If a Product doesn't exist and needs to be created on the fly, the
// product_display_name field refers to [Product.display_name][google.cloud.vision.v1p3beta1.Product.display_name], the
// product_category field refers to [Product.product_category][google.cloud.vision.v1p3beta1.Product.product_category], and the
// labels field refers to [Product.labels][].
// product_display_name field refers to
// [Product.display_name][google.cloud.vision.v1p3beta1.Product.display_name],
// the product_category field refers to
// [Product.product_category][google.cloud.vision.v1p3beta1.Product.product_category],
// and the labels field refers to [Product.labels][].
//
// Labels (optional) should be a line containing a list of comma-separated
// key-value pairs, with the format
@ -772,8 +786,10 @@ message ImportProductSetsRequest {
// Response message for the `ImportProductSets` method.
//
// This message is returned by the
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response] field.
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]
// method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response]
// field.
message ImportProductSetsResponse {
// The list of reference_images that are imported successfully.
repeated ReferenceImage reference_images = 1;
@ -820,6 +836,7 @@ message BatchOperationMetadata {
google.protobuf.Timestamp submit_time = 2;
// The time when the batch request is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
google.protobuf.Timestamp end_time = 3;
}

View File

@ -25,14 +25,14 @@ option java_multiple_files = true;
option java_outer_classname = "TextAnnotationProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// TextAnnotation contains a structured representation of OCR extracted text.
// The hierarchy of an OCR extracted text structure is like this:
// TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
// Each structural component, starting from Page, may further have their own
// properties. Properties describe detected languages, breaks etc.. Please refer
// to the [TextAnnotation.TextProperty][google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty] message definition below for more
// detail.
// to the
// [TextAnnotation.TextProperty][google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty]
// message definition below for more detail.
message TextAnnotation {
// Detected language for a structural component.
message DetectedLanguage {

View File

@ -24,7 +24,6 @@ option java_multiple_files = true;
option java_outer_classname = "WebDetectionProto";
option java_package = "com.google.cloud.vision.v1p3beta1";
// Relevant information for the image from the Internet.
message WebDetection {
// Entity deduced from similar images on the Internet.

View File

@ -26,7 +26,6 @@ option java_outer_classname = "GeometryProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// A vertex represents a 2D point in the image.
// NOTE: the vertex coordinates are in the same scale as the original image.
message Vertex {

View File

@ -36,13 +36,13 @@ option java_outer_classname = "ImageAnnotatorProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// 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.
service ImageAnnotator {
// Run image detection and annotation for a batch of images.
rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse) {
rpc BatchAnnotateImages(BatchAnnotateImagesRequest)
returns (BatchAnnotateImagesResponse) {
option (google.api.http) = {
post: "/v1p4beta1/images:annotate"
body: "*"
@ -55,7 +55,8 @@ service ImageAnnotator {
// This service will extract at most the first 10 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) {
rpc BatchAnnotateFiles(BatchAnnotateFilesRequest)
returns (BatchAnnotateFilesResponse) {
option (google.api.http) = {
post: "/v1p4beta1/files:annotate"
body: "*"
@ -71,7 +72,8 @@ service ImageAnnotator {
//
// 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) {
rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p4beta1/images:asyncBatchAnnotate"
body: "*"
@ -84,7 +86,8 @@ service ImageAnnotator {
// `google.longrunning.Operations` interface.
// `Operation.metadata` contains `OperationMetadata` (metadata).
// `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (google.longrunning.Operation) {
rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p4beta1/files:asyncBatchAnnotate"
body: "*"

View File

@ -29,14 +29,15 @@ option java_outer_classname = "ProductSearchProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// Parameters for a product search request.
message ProductSearchParams {
// The bounding polygon around the area of interest in the image.
// Optional. If it is not specified, system discretion will be applied.
BoundingPoly bounding_poly = 9;
// The resource name of a [ProductSet][google.cloud.vision.v1p4beta1.ProductSet] to be searched for similar images.
// The resource name of a
// [ProductSet][google.cloud.vision.v1p4beta1.ProductSet] to be searched for
// similar images.
//
// Format is:
// `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.

View File

@ -32,20 +32,23 @@ option java_outer_classname = "ProductSearchServiceProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// Manages Products and ProductSets of reference images for use in product
// search. It uses the following resource model:
//
// - The API has a collection of [ProductSet][google.cloud.vision.v1p4beta1.ProductSet] resources, named
// - The API has a collection of
// [ProductSet][google.cloud.vision.v1p4beta1.ProductSet] resources, named
// `projects/*/locations/*/productSets/*`, which acts as a way to put different
// products into groups to limit identification.
//
// In parallel,
//
// - The API has a collection of [Product][google.cloud.vision.v1p4beta1.Product] resources, named
// - The API has a collection of
// [Product][google.cloud.vision.v1p4beta1.Product] resources, named
// `projects/*/locations/*/products/*`
//
// - Each [Product][google.cloud.vision.v1p4beta1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1p4beta1.ReferenceImage] resources, named
// - Each [Product][google.cloud.vision.v1p4beta1.Product] has a collection of
// [ReferenceImage][google.cloud.vision.v1p4beta1.ReferenceImage] resources,
// named
// `projects/*/locations/*/products/*/referenceImages/*`
service ProductSearch {
// Creates and returns a new ProductSet resource.
@ -67,7 +70,8 @@ service ProductSearch {
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100, or less
// than 1.
rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse) {
rpc ListProductSets(ListProductSetsRequest)
returns (ListProductSetsResponse) {
option (google.api.http) = {
get: "/v1p4beta1/{parent=projects/*/locations/*}/productSets"
};
@ -107,7 +111,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the ProductSet does not exist.
rpc DeleteProductSet(DeleteProductSetRequest) returns (google.protobuf.Empty) {
rpc DeleteProductSet(DeleteProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1p4beta1/{name=projects/*/locations/*/productSets/*}"
};
@ -206,7 +211,8 @@ service ProductSearch {
// * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing
// compatible with the parent product's product_category is detected.
// * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage) {
rpc CreateReferenceImage(CreateReferenceImageRequest)
returns (ReferenceImage) {
option (google.api.http) = {
post: "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages"
body: "reference_image"
@ -224,7 +230,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the reference image does not exist.
rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (google.protobuf.Empty) {
rpc DeleteReferenceImage(DeleteReferenceImageRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1p4beta1/{name=projects/*/locations/*/products/*/referenceImages/*}"
};
@ -237,7 +244,8 @@ service ProductSearch {
// * Returns NOT_FOUND if the parent product does not exist.
// * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less
// than 1.
rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse) {
rpc ListReferenceImages(ListReferenceImagesRequest)
returns (ListReferenceImagesResponse) {
option (google.api.http) = {
get: "/v1p4beta1/{parent=projects/*/locations/*/products/*}/referenceImages"
};
@ -262,7 +270,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
rpc AddProductToProductSet(AddProductToProductSetRequest) returns (google.protobuf.Empty) {
rpc AddProductToProductSet(AddProductToProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:addProduct"
body: "*"
@ -274,7 +283,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns NOT_FOUND If the Product is not found under the ProductSet.
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (google.protobuf.Empty) {
rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1p4beta1/{name=projects/*/locations/*/productSets/*}:removeProduct"
body: "*"
@ -288,7 +298,8 @@ service ProductSearch {
// Possible errors:
//
// * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse) {
rpc ListProductsInProductSet(ListProductsInProductSetRequest)
returns (ListProductsInProductSetResponse) {
option (google.api.http) = {
get: "/v1p4beta1/{name=projects/*/locations/*/productSets/*}/products"
};
@ -297,15 +308,16 @@ service ProductSearch {
// Asynchronous API that imports a list of reference images to specified
// product sets based on a list of image information.
//
// The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
// progress and results of the request.
// The [google.longrunning.Operation][google.longrunning.Operation] API can be
// used to keep track of the progress and results of the request.
// `Operation.metadata` contains `BatchOperationMetadata`. (progress)
// `Operation.response` contains `ImportProductSetsResponse`. (results)
//
// The input source of this method is a csv file on Google Cloud Storage.
// For the format of the csv file please see
// [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1p4beta1.ImportProductSetsGcsSource.csv_file_uri].
rpc ImportProductSets(ImportProductSetsRequest) returns (google.longrunning.Operation) {
rpc ImportProductSets(ImportProductSetsRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1p4beta1/{parent=projects/*/locations/*}/productSets:import"
body: "*"
@ -719,15 +731,17 @@ message ImportProductSetsGcsSource {
// `product-display-name` column refers to
// [display_name][google.cloud.vision.v1p4beta1.Product.display_name], the
// `product-category` column refers to
// [product_category][google.cloud.vision.v1p4beta1.Product.product_category], and the
// `labels` column refers to [product_labels][google.cloud.vision.v1p4beta1.Product.product_labels].
// [product_category][google.cloud.vision.v1p4beta1.Product.product_category],
// and the `labels` column refers to
// [product_labels][google.cloud.vision.v1p4beta1.Product.product_labels].
//
// The `image-id` column is optional but must be unique if provided. If it is
// empty, the system will automatically assign a unique id to the image.
//
// The `product-display-name` column is optional. If it is empty, the system
// sets the [display_name][google.cloud.vision.v1p4beta1.Product.display_name] field for the product to a
// space (" "). You can update the `display_name` later by using the API.
// sets the [display_name][google.cloud.vision.v1p4beta1.Product.display_name]
// field for the product to a space (" "). You can update the `display_name`
// later by using the API.
//
// If a `Product` with the specified `product-id` already exists, then the
// system ignores the `product-display-name`, `product-category`, and `labels`
@ -782,8 +796,10 @@ message ImportProductSetsRequest {
// Response message for the `ImportProductSets` method.
//
// This message is returned by the
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response] field.
// [google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]
// method in the returned
// [google.longrunning.Operation.response][google.longrunning.Operation.response]
// field.
message ImportProductSetsResponse {
// The list of reference_images that are imported successfully.
repeated ReferenceImage reference_images = 1;
@ -830,6 +846,7 @@ message BatchOperationMetadata {
google.protobuf.Timestamp submit_time = 2;
// The time when the batch request is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
google.protobuf.Timestamp end_time = 3;
}

View File

@ -27,14 +27,14 @@ option java_outer_classname = "TextAnnotationProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// TextAnnotation contains a structured representation of OCR extracted text.
// The hierarchy of an OCR extracted text structure is like this:
// TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
// Each structural component, starting from Page, may further have their own
// properties. Properties describe detected languages, breaks etc.. Please refer
// to the [TextAnnotation.TextProperty][google.cloud.vision.v1p4beta1.TextAnnotation.TextProperty] message definition below for more
// detail.
// to the
// [TextAnnotation.TextProperty][google.cloud.vision.v1p4beta1.TextAnnotation.TextProperty]
// message definition below for more detail.
message TextAnnotation {
// Detected language for a structural component.
message DetectedLanguage {

View File

@ -26,7 +26,6 @@ option java_outer_classname = "WebDetectionProto";
option java_package = "com.google.cloud.vision.v1p4beta1";
option objc_class_prefix = "GCVN";
// Relevant information for the image from the Internet.
message WebDetection {
// Entity deduced from similar images on the Internet.