1- // Copyright 2022 Google LLC
1+ // Copyright 2023 Google LLC
22//
33// Licensed under the Apache License, Version 2.0 (the "License");
44// you may not use this file except in compliance with the License.
@@ -46,7 +46,8 @@ service ImageAnnotator {
4646 "https://www.googleapis.com/auth/cloud-vision" ;
4747
4848 // Run image detection and annotation for a batch of images.
49- rpc BatchAnnotateImages (BatchAnnotateImagesRequest ) returns (BatchAnnotateImagesResponse ) {
49+ rpc BatchAnnotateImages (BatchAnnotateImagesRequest )
50+ returns (BatchAnnotateImagesResponse ) {
5051 option (google.api.http ) = {
5152 post : "/v1/images:annotate"
5253 body : "*"
@@ -69,7 +70,8 @@ service ImageAnnotator {
6970 // AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each
7071 // file provided and perform detection and annotation for each image
7172 // extracted.
72- rpc BatchAnnotateFiles (BatchAnnotateFilesRequest ) returns (BatchAnnotateFilesResponse ) {
73+ rpc BatchAnnotateFiles (BatchAnnotateFilesRequest )
74+ returns (BatchAnnotateFilesResponse ) {
7375 option (google.api.http ) = {
7476 post : "/v1/files:annotate"
7577 body : "*"
@@ -94,7 +96,8 @@ service ImageAnnotator {
9496 //
9597 // This service will write image annotation outputs to json files in customer
9698 // GCS bucket, each json file containing BatchAnnotateImagesResponse proto.
97- rpc AsyncBatchAnnotateImages (AsyncBatchAnnotateImagesRequest ) returns (google.longrunning.Operation ) {
99+ rpc AsyncBatchAnnotateImages (AsyncBatchAnnotateImagesRequest )
100+ returns (google.longrunning.Operation ) {
98101 option (google.api.http ) = {
99102 post : "/v1/images:asyncBatchAnnotate"
100103 body : "*"
@@ -120,7 +123,8 @@ service ImageAnnotator {
120123 // `google.longrunning.Operations` interface.
121124 // `Operation.metadata` contains `OperationMetadata` (metadata).
122125 // `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).
123- rpc AsyncBatchAnnotateFiles (AsyncBatchAnnotateFilesRequest ) returns (google.longrunning.Operation ) {
126+ rpc AsyncBatchAnnotateFiles (AsyncBatchAnnotateFilesRequest )
127+ returns (google.longrunning.Operation ) {
124128 option (google.api.http ) = {
125129 post : "/v1/files:asyncBatchAnnotate"
126130 body : "*"
@@ -566,7 +570,9 @@ message SafeSearchAnnotation {
566570 // Likelihood that this is a medical image.
567571 Likelihood medical = 3 ;
568572
569- // Likelihood that this image contains violent content.
573+ // Likelihood that this image contains violent content. Violent content may
574+ // include death, serious harm, or injury to individuals or groups of
575+ // individuals.
570576 Likelihood violence = 4 ;
571577
572578 // Likelihood that the request image contains racy content. Racy content may
@@ -644,8 +650,8 @@ message CropHintsParams {
644650
645651// Parameters for web detection request.
646652message WebDetectionParams {
647- // Whether to include results derived from the geo information in the image .
648- bool include_geo_results = 2 ;
653+ // This field has no effect on results .
654+ bool include_geo_results = 2 [ deprecated = true ] ;
649655}
650656
651657// Parameters for text detections. This is used to control TEXT_DETECTION and
@@ -656,7 +662,13 @@ message TextDetectionParams {
656662 // score for TEXT_DETECTION as well.
657663 bool enable_text_detection_confidence_score = 9 ;
658664
659- // A list of advanced OCR options to fine-tune OCR behavior.
665+ // A list of advanced OCR options to further fine-tune OCR behavior.
666+ // Current valid values are:
667+ //
668+ // - `legacy_layout`: a heuristics layout detection algorithm, which serves as
669+ // an alternative to the current ML-based layout detection algorithm.
670+ // Customers can choose the best suitable layout algorithm based on their
671+ // situation.
660672 repeated string advanced_ocr_options = 11 ;
661673}
662674
@@ -767,7 +779,8 @@ message AnnotateImageResponse {
767779// Multiple image annotation requests are batched into a single service call.
768780message BatchAnnotateImagesRequest {
769781 // Required. Individual image annotation requests for this batch.
770- repeated AnnotateImageRequest requests = 1 [(google.api.field_behavior ) = REQUIRED ];
782+ repeated AnnotateImageRequest requests = 1
783+ [(google.api.field_behavior ) = REQUIRED ];
771784
772785 // Optional. Target project and location to make a call.
773786 //
@@ -782,6 +795,14 @@ message BatchAnnotateImagesRequest {
782795 //
783796 // Example: `projects/project-A/locations/eu`.
784797 string parent = 4 ;
798+
799+ // Optional. The labels with user-defined metadata for the request.
800+ //
801+ // Label keys and values can be no longer than 63 characters
802+ // (Unicode codepoints), can only contain lowercase letters, numeric
803+ // characters, underscores and dashes. International characters are allowed.
804+ // Label values are optional. Label keys must start with a letter.
805+ map <string , string > labels = 5 [(google.api.field_behavior ) = OPTIONAL ];
785806}
786807
787808// Response to a batch image annotation request.
@@ -838,9 +859,10 @@ message AnnotateFileResponse {
838859
839860// A list of requests to annotate files using the BatchAnnotateFiles API.
840861message BatchAnnotateFilesRequest {
841- // Required. The list of file annotation requests. Right now we support only one
842- // AnnotateFileRequest in BatchAnnotateFilesRequest.
843- repeated AnnotateFileRequest requests = 1 [(google.api.field_behavior ) = REQUIRED ];
862+ // Required. The list of file annotation requests. Right now we support only
863+ // one AnnotateFileRequest in BatchAnnotateFilesRequest.
864+ repeated AnnotateFileRequest requests = 1
865+ [(google.api.field_behavior ) = REQUIRED ];
844866
845867 // Optional. Target project and location to make a call.
846868 //
@@ -855,6 +877,14 @@ message BatchAnnotateFilesRequest {
855877 //
856878 // Example: `projects/project-A/locations/eu`.
857879 string parent = 3 ;
880+
881+ // Optional. The labels with user-defined metadata for the request.
882+ //
883+ // Label keys and values can be no longer than 63 characters
884+ // (Unicode codepoints), can only contain lowercase letters, numeric
885+ // characters, underscores and dashes. International characters are allowed.
886+ // Label values are optional. Label keys must start with a letter.
887+ map <string , string > labels = 5 [(google.api.field_behavior ) = OPTIONAL ];
858888}
859889
860890// A list of file annotation responses.
@@ -888,7 +918,8 @@ message AsyncAnnotateFileResponse {
888918// Request for async image annotation for a list of images.
889919message AsyncBatchAnnotateImagesRequest {
890920 // Required. Individual image annotation requests for this batch.
891- repeated AnnotateImageRequest requests = 1 [(google.api.field_behavior ) = REQUIRED ];
921+ repeated AnnotateImageRequest requests = 1
922+ [(google.api.field_behavior ) = REQUIRED ];
892923
893924 // Required. The desired output location and metadata (e.g. format).
894925 OutputConfig output_config = 2 [(google.api.field_behavior ) = REQUIRED ];
@@ -906,6 +937,14 @@ message AsyncBatchAnnotateImagesRequest {
906937 //
907938 // Example: `projects/project-A/locations/eu`.
908939 string parent = 4 ;
940+
941+ // Optional. The labels with user-defined metadata for the request.
942+ //
943+ // Label keys and values can be no longer than 63 characters
944+ // (Unicode codepoints), can only contain lowercase letters, numeric
945+ // characters, underscores and dashes. International characters are allowed.
946+ // Label values are optional. Label keys must start with a letter.
947+ map <string , string > labels = 5 [(google.api.field_behavior ) = OPTIONAL ];
909948}
910949
911950// Response to an async batch image annotation request.
@@ -918,7 +957,8 @@ message AsyncBatchAnnotateImagesResponse {
918957// call.
919958message AsyncBatchAnnotateFilesRequest {
920959 // Required. Individual async file annotation requests for this batch.
921- repeated AsyncAnnotateFileRequest requests = 1 [(google.api.field_behavior ) = REQUIRED ];
960+ repeated AsyncAnnotateFileRequest requests = 1
961+ [(google.api.field_behavior ) = REQUIRED ];
922962
923963 // Optional. Target project and location to make a call.
924964 //
@@ -933,6 +973,14 @@ message AsyncBatchAnnotateFilesRequest {
933973 //
934974 // Example: `projects/project-A/locations/eu`.
935975 string parent = 4 ;
976+
977+ // Optional. The labels with user-defined metadata for the request.
978+ //
979+ // Label keys and values can be no longer than 63 characters
980+ // (Unicode codepoints), can only contain lowercase letters, numeric
981+ // characters, underscores and dashes. International characters are allowed.
982+ // Label values are optional. Label keys must start with a letter.
983+ map <string , string > labels = 5 [(google.api.field_behavior ) = OPTIONAL ];
936984}
937985
938986// Response to an async batch file annotation request.
0 commit comments