legacy-libs/google-proto-files/google/cloud/vision/v1p4beta1/web_detection.proto

   1 // Copyright 2018 Google LLC.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14 //
  15
  16 syntax = "proto3";
  17
  18 package google.cloud.vision.v1p4beta1;
  19
  20 import "google/api/annotations.proto";
  21
  22 option cc_enable_arenas = true;
  23 option go_package = "google.golang.org/genproto/googleapis/cloud/vision/v1p4beta1;vision";
  24 option java_multiple_files = true;
  25 option java_outer_classname = "WebDetectionProto";
  26 option java_package = "com.google.cloud.vision.v1p4beta1";
  27 option objc_class_prefix = "GCVN";
  28
  29 // Relevant information for the image from the Internet.
  30 message WebDetection {
  31   // Entity deduced from similar images on the Internet.
  32   message WebEntity {
  33     // Opaque entity ID.
  34     string entity_id = 1;
  35
  36     // Overall relevancy score for the entity.
  37     // Not normalized and not comparable across different image queries.
  38     float score = 2;
  39
  40     // Canonical description of the entity, in English.
  41     string description = 3;
  42   }
  43
  44   // Metadata for online images.
  45   message WebImage {
  46     // The result image URL.
  47     string url = 1;
  48
  49     // (Deprecated) Overall relevancy score for the image.
  50     float score = 2;
  51   }
  52
  53   // Label to provide extra metadata for the web detection.
  54   message WebLabel {
  55     // Label for extra metadata.
  56     string label = 1;
  57
  58     // The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".
  59     // For more information, see
  60     // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  61     string language_code = 2;
  62   }
  63
  64   // Metadata for web pages.
  65   message WebPage {
  66     // The result web page URL.
  67     string url = 1;
  68
  69     // (Deprecated) Overall relevancy score for the web page.
  70     float score = 2;
  71
  72     // Title for the web page, may contain HTML markups.
  73     string page_title = 3;
  74
  75     // Fully matching images on the page.
  76     // Can include resized copies of the query image.
  77     repeated WebImage full_matching_images = 4;
  78
  79     // Partial matching images on the page.
  80     // Those images are similar enough to share some key-point features. For
  81     // example an original image will likely have partial matching for its
  82     // crops.
  83     repeated WebImage partial_matching_images = 5;
  84   }
  85
  86   // Deduced entities from similar images on the Internet.
  87   repeated WebEntity web_entities = 1;
  88
  89   // Fully matching images from the Internet.
  90   // Can include resized copies of the query image.
  91   repeated WebImage full_matching_images = 2;
  92
  93   // Partial matching images from the Internet.
  94   // Those images are similar enough to share some key-point features. For
  95   // example an original image will likely have partial matching for its crops.
  96   repeated WebImage partial_matching_images = 3;
  97
  98   // Web pages containing the matching images from the Internet.
  99   repeated WebPage pages_with_matching_images = 4;
 100
 101   // The visually similar image results.
 102   repeated WebImage visually_similar_images = 6;
 103
 104   // The service's best guess as to the topic of the request image.
 105   // Inferred from similar images on the open web.
 106   repeated WebLabel best_guess_labels = 8;
 107 }