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

   1 // Copyright 2017 Google Inc.
   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 syntax = "proto3";
  16
  17 package google.cloud.vision.v1p1beta1;
  18
  19 import "google/api/annotations.proto";
  20
  21 option cc_enable_arenas = true;
  22 option go_package = "google.golang.org/genproto/googleapis/cloud/vision/v1p1beta1;vision";
  23 option java_multiple_files = true;
  24 option java_outer_classname = "WebDetectionProto";
  25 option java_package = "com.google.cloud.vision.v1p1beta1";
  26
  27 // Relevant information for the image from the Internet.
  28 message WebDetection {
  29   // Entity deduced from similar images on the Internet.
  30   message WebEntity {
  31     // Opaque entity ID.
  32     string entity_id = 1;
  33
  34     // Overall relevancy score for the entity.
  35     // Not normalized and not comparable across different image queries.
  36     float score = 2;
  37
  38     // Canonical description of the entity, in English.
  39     string description = 3;
  40   }
  41
  42   // Metadata for online images.
  43   message WebImage {
  44     // The result image URL.
  45     string url = 1;
  46
  47     // (Deprecated) Overall relevancy score for the image.
  48     float score = 2;
  49   }
  50
  51   // Metadata for web pages.
  52   message WebPage {
  53     // The result web page URL.
  54     string url = 1;
  55
  56     // (Deprecated) Overall relevancy score for the web page.
  57     float score = 2;
  58
  59     // Title for the web page, may contain HTML markups.
  60     string page_title = 3;
  61
  62     // Fully matching images on the page.
  63     // Can include resized copies of the query image.
  64     repeated WebImage full_matching_images = 4;
  65
  66     // Partial matching images on the page.
  67     // Those images are similar enough to share some key-point features. For
  68     // example an original image will likely have partial matching for its
  69     // crops.
  70     repeated WebImage partial_matching_images = 5;
  71   }
  72
  73   // Label to provide extra metadata for the web detection.
  74   message WebLabel {
  75     // Label for extra metadata.
  76     string label = 1;
  77
  78     // The BCP-47 language code for `label`, such as "en-US" or "sr-Latn".
  79     // For more information, see
  80     // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  81     string language_code = 2;
  82   }
  83
  84   // Deduced entities from similar images on the Internet.
  85   repeated WebEntity web_entities = 1;
  86
  87   // Fully matching images from the Internet.
  88   // Can include resized copies of the query image.
  89   repeated WebImage full_matching_images = 2;
  90
  91   // Partial matching images from the Internet.
  92   // Those images are similar enough to share some key-point features. For
  93   // example an original image will likely have partial matching for its crops.
  94   repeated WebImage partial_matching_images = 3;
  95
  96   // Web pages containing the matching images from the Internet.
  97   repeated WebPage pages_with_matching_images = 4;
  98
  99   // The visually similar image results.
 100   repeated WebImage visually_similar_images = 6;
 101
 102   // Best guess text labels for the request image.
 103   repeated WebLabel best_guess_labels = 8;
 104 }