Index: discovery/googleapis/vision__v1.json |
diff --git a/discovery/googleapis/vision__v1.json b/discovery/googleapis/vision__v1.json |
index b48bdf29fdf0d60b2cd65b3b957fe8c65b562f68..9676ff85df0ef34aba16bcb58121e90e0bee6dee 100644 |
--- a/discovery/googleapis/vision__v1.json |
+++ b/discovery/googleapis/vision__v1.json |
@@ -28,6 +28,48 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "upload_protocol": { |
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "prettyPrint": { |
+ "default": "true", |
+ "description": "Returns response with indentations and line breaks.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "callback": { |
+ "description": "JSONP", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"$.xgafv": { |
"description": "V1 error format.", |
"enum": [ |
@@ -41,11 +83,6 @@ |
"location": "query", |
"type": "string" |
}, |
- "callback": { |
- "description": "JSONP", |
- "location": "query", |
- "type": "string" |
- }, |
"alt": { |
"default": "json", |
"description": "Data format for response.", |
@@ -62,55 +99,18 @@ |
"location": "query", |
"type": "string" |
}, |
- "access_token": { |
- "description": "OAuth access token.", |
- "location": "query", |
- "type": "string" |
- }, |
"key": { |
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
"location": "query", |
"type": "string" |
}, |
- "quotaUser": { |
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "location": "query", |
- "type": "string" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
- "upload_protocol": { |
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
- "location": "query", |
- "type": "string" |
- }, |
- "prettyPrint": { |
- "default": "true", |
- "description": "Returns response with indentations and line breaks.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
+ "quotaUser": { |
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
"location": "query", |
"type": "string" |
} |
@@ -143,1010 +143,863 @@ |
"revision": "20170725", |
"rootUrl": "https://vision.googleapis.com/", |
"schemas": { |
- "AnnotateImageResponse": { |
- "description": "Response to an image annotation request.", |
- "id": "AnnotateImageResponse", |
+ "Feature": { |
+ "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.", |
+ "id": "Feature", |
"properties": { |
- "error": { |
- "$ref": "Status", |
- "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." |
- }, |
- "fullTextAnnotation": { |
- "$ref": "TextAnnotation", |
- "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." |
- }, |
- "landmarkAnnotations": { |
- "description": "If present, landmark detection has completed successfully.", |
- "items": { |
- "$ref": "EntityAnnotation" |
- }, |
- "type": "array" |
- }, |
- "textAnnotations": { |
- "description": "If present, text (OCR) detection has completed successfully.", |
- "items": { |
- "$ref": "EntityAnnotation" |
- }, |
- "type": "array" |
- }, |
- "imagePropertiesAnnotation": { |
- "$ref": "ImageProperties", |
- "description": "If present, image properties were extracted successfully." |
- }, |
- "faceAnnotations": { |
- "description": "If present, face detection has completed successfully.", |
- "items": { |
- "$ref": "FaceAnnotation" |
- }, |
- "type": "array" |
- }, |
- "logoAnnotations": { |
- "description": "If present, logo detection has completed successfully.", |
- "items": { |
- "$ref": "EntityAnnotation" |
- }, |
- "type": "array" |
- }, |
- "webDetection": { |
- "$ref": "WebDetection", |
- "description": "If present, web detection has completed successfully." |
- }, |
- "cropHintsAnnotation": { |
- "$ref": "CropHintsAnnotation", |
- "description": "If present, crop hints have completed successfully." |
- }, |
- "safeSearchAnnotation": { |
- "$ref": "SafeSearchAnnotation", |
- "description": "If present, safe-search annotation has completed successfully." |
+ "maxResults": { |
+ "description": "Maximum number of results of this type.", |
+ "format": "int32", |
+ "type": "integer" |
}, |
- "labelAnnotations": { |
- "description": "If present, label detection has completed successfully.", |
- "items": { |
- "$ref": "EntityAnnotation" |
- }, |
- "type": "array" |
+ "type": { |
+ "description": "The feature type.", |
+ "enum": [ |
+ "TYPE_UNSPECIFIED", |
+ "FACE_DETECTION", |
+ "LANDMARK_DETECTION", |
+ "LOGO_DETECTION", |
+ "LABEL_DETECTION", |
+ "TEXT_DETECTION", |
+ "DOCUMENT_TEXT_DETECTION", |
+ "SAFE_SEARCH_DETECTION", |
+ "IMAGE_PROPERTIES", |
+ "CROP_HINTS", |
+ "WEB_DETECTION" |
+ ], |
+ "enumDescriptions": [ |
+ "Unspecified feature type.", |
+ "Run face detection.", |
+ "Run landmark detection.", |
+ "Run logo detection.", |
+ "Run label detection.", |
+ "Run OCR.", |
+ "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.", |
+ "Run computer vision models to compute image safe-search properties.", |
+ "Compute a set of image properties, such as the image's dominant colors.", |
+ "Run crop hints.", |
+ "Run web detection." |
+ ], |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "CropHintsParams": { |
- "description": "Parameters for crop hints annotation request.", |
- "id": "CropHintsParams", |
+ "ImageProperties": { |
+ "description": "Stores image properties, such as dominant colors.", |
+ "id": "ImageProperties", |
"properties": { |
- "aspectRatios": { |
- "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", |
- "items": { |
- "format": "float", |
- "type": "number" |
- }, |
- "type": "array" |
+ "dominantColors": { |
+ "$ref": "DominantColorsAnnotation", |
+ "description": "If present, dominant colors completed successfully." |
} |
}, |
"type": "object" |
}, |
- "Block": { |
- "description": "Logical element on the page.", |
- "id": "Block", |
+ "SafeSearchAnnotation": { |
+ "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", |
+ "id": "SafeSearchAnnotation", |
"properties": { |
- "boundingBox": { |
- "$ref": "BoundingPoly", |
- "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
- }, |
- "paragraphs": { |
- "description": "List of paragraphs in this block (if this blocks is of type text).", |
- "items": { |
- "$ref": "Paragraph" |
- }, |
- "type": "array" |
- }, |
- "property": { |
- "$ref": "TextProperty", |
- "description": "Additional information detected for the block." |
- }, |
- "blockType": { |
- "description": "Detected block type (text, image etc) for this block.", |
+ "violence": { |
+ "description": "Violence likelihood.", |
"enum": [ |
"UNKNOWN", |
- "TEXT", |
- "TABLE", |
- "PICTURE", |
- "RULER", |
- "BARCODE" |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
], |
"enumDescriptions": [ |
- "Unknown block type.", |
- "Regular text block.", |
- "Table block.", |
- "Image block.", |
- "Horizontal/vertical line box.", |
- "Barcode block." |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
], |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "WebDetection": { |
- "description": "Relevant information for the image from the Internet.", |
- "id": "WebDetection", |
- "properties": { |
- "fullMatchingImages": { |
- "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", |
- "items": { |
- "$ref": "WebImage" |
- }, |
- "type": "array" |
- }, |
- "webEntities": { |
- "description": "Deduced entities from similar images on the Internet.", |
- "items": { |
- "$ref": "WebEntity" |
- }, |
- "type": "array" |
}, |
- "pagesWithMatchingImages": { |
- "description": "Web pages containing the matching images from the Internet.", |
- "items": { |
- "$ref": "WebPage" |
- }, |
- "type": "array" |
+ "adult": { |
+ "description": "Represents the adult content likelihood for the image.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
+ ], |
+ "type": "string" |
}, |
- "visuallySimilarImages": { |
- "description": "The visually similar image results.", |
- "items": { |
- "$ref": "WebImage" |
- }, |
- "type": "array" |
+ "spoof": { |
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
+ ], |
+ "type": "string" |
}, |
- "partialMatchingImages": { |
- "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", |
- "items": { |
- "$ref": "WebImage" |
- }, |
- "type": "array" |
+ "medical": { |
+ "description": "Likelihood that this is a medical image.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
+ ], |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "BatchAnnotateImagesResponse": { |
- "description": "Response to a batch image annotation request.", |
- "id": "BatchAnnotateImagesResponse", |
+ "DominantColorsAnnotation": { |
+ "description": "Set of dominant colors and their corresponding scores.", |
+ "id": "DominantColorsAnnotation", |
"properties": { |
- "responses": { |
- "description": "Individual responses to image annotation requests within the batch.", |
+ "colors": { |
+ "description": "RGB color values with their score and pixel fraction.", |
"items": { |
- "$ref": "AnnotateImageResponse" |
+ "$ref": "ColorInfo" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "ImageSource": { |
- "description": "External image source (Google Cloud Storage image location).", |
- "id": "ImageSource", |
+ "TextAnnotation": { |
+ "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\nrefer to the google.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for more detail.", |
+ "id": "TextAnnotation", |
"properties": { |
- "gcsImageUri": { |
- "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.", |
- "type": "string" |
+ "pages": { |
+ "description": "List of pages detected by OCR.", |
+ "items": { |
+ "$ref": "Page" |
+ }, |
+ "type": "array" |
}, |
- "imageUri": { |
- "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", |
+ "text": { |
+ "description": "UTF-8 text detected on the pages.", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "LocationInfo": { |
- "description": "Detected entity location information.", |
- "id": "LocationInfo", |
+ "Vertex": { |
+ "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", |
+ "id": "Vertex", |
"properties": { |
- "latLng": { |
- "$ref": "LatLng", |
- "description": "lat/long location coordinates." |
+ "y": { |
+ "description": "Y coordinate.", |
+ "format": "int32", |
+ "type": "integer" |
+ }, |
+ "x": { |
+ "description": "X coordinate.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
}, |
- "Property": { |
- "description": "A `Property` consists of a user-supplied name/value pair.", |
- "id": "Property", |
+ "DetectedLanguage": { |
+ "description": "Detected language for a structural component.", |
+ "id": "DetectedLanguage", |
"properties": { |
- "value": { |
- "description": "Value of the property.", |
- "type": "string" |
- }, |
- "uint64Value": { |
- "description": "Value of numeric properties.", |
- "format": "uint64", |
+ "languageCode": { |
+ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", |
"type": "string" |
}, |
- "name": { |
- "description": "Name of the property.", |
- "type": "string" |
+ "confidence": { |
+ "description": "Confidence of detected language. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
} |
}, |
"type": "object" |
}, |
- "Position": { |
- "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", |
- "id": "Position", |
+ "TextProperty": { |
+ "description": "Additional information detected on the structural component.", |
+ "id": "TextProperty", |
"properties": { |
- "z": { |
- "description": "Z coordinate (or depth).", |
- "format": "float", |
- "type": "number" |
- }, |
- "x": { |
- "description": "X coordinate.", |
- "format": "float", |
- "type": "number" |
+ "detectedLanguages": { |
+ "description": "A list of detected languages together with confidence.", |
+ "items": { |
+ "$ref": "DetectedLanguage" |
+ }, |
+ "type": "array" |
}, |
- "y": { |
- "description": "Y coordinate.", |
- "format": "float", |
- "type": "number" |
+ "detectedBreak": { |
+ "$ref": "DetectedBreak", |
+ "description": "Detected start or end of a text segment." |
} |
}, |
"type": "object" |
}, |
- "ColorInfo": { |
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", |
- "id": "ColorInfo", |
+ "BoundingPoly": { |
+ "description": "A bounding polygon for the detected image annotation.", |
+ "id": "BoundingPoly", |
"properties": { |
- "pixelFraction": { |
- "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", |
- "format": "float", |
- "type": "number" |
- }, |
- "color": { |
- "$ref": "Color", |
- "description": "RGB components of the color." |
- }, |
- "score": { |
- "description": "Image-specific score for this color. Value in range [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "vertices": { |
+ "description": "The bounding polygon vertices.", |
+ "items": { |
+ "$ref": "Vertex" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "WebPage": { |
- "description": "Metadata for web pages.", |
- "id": "WebPage", |
+ "WebEntity": { |
+ "description": "Entity deduced from similar images on the Internet.", |
+ "id": "WebEntity", |
"properties": { |
+ "entityId": { |
+ "description": "Opaque entity ID.", |
+ "type": "string" |
+ }, |
+ "description": { |
+ "description": "Canonical description of the entity, in English.", |
+ "type": "string" |
+ }, |
"score": { |
- "description": "Overall relevancy score for the web page.\nNot normalized and not comparable across different image queries.", |
+ "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", |
"format": "float", |
"type": "number" |
- }, |
- "url": { |
- "description": "The result web page URL.", |
- "type": "string" |
} |
}, |
"type": "object" |
}, |
- "EntityAnnotation": { |
- "description": "Set of detected entity features.", |
- "id": "EntityAnnotation", |
+ "AnnotateImageResponse": { |
+ "description": "Response to an image annotation request.", |
+ "id": "AnnotateImageResponse", |
"properties": { |
- "score": { |
- "description": "Overall score of the result. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
- }, |
- "locations": { |
- "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", |
+ "landmarkAnnotations": { |
+ "description": "If present, landmark detection has completed successfully.", |
"items": { |
- "$ref": "LocationInfo" |
+ "$ref": "EntityAnnotation" |
}, |
"type": "array" |
}, |
- "mid": { |
- "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", |
- "type": "string" |
- }, |
- "confidence": { |
- "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "textAnnotations": { |
+ "description": "If present, text (OCR) detection has completed successfully.", |
+ "items": { |
+ "$ref": "EntityAnnotation" |
+ }, |
+ "type": "array" |
}, |
- "locale": { |
- "description": "The language code for the locale in which the entity textual\n`description` is expressed.", |
- "type": "string" |
+ "imagePropertiesAnnotation": { |
+ "$ref": "ImageProperties", |
+ "description": "If present, image properties were extracted successfully." |
}, |
- "boundingPoly": { |
- "$ref": "BoundingPoly", |
- "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." |
+ "faceAnnotations": { |
+ "description": "If present, face detection has completed successfully.", |
+ "items": { |
+ "$ref": "FaceAnnotation" |
+ }, |
+ "type": "array" |
}, |
- "topicality": { |
- "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "logoAnnotations": { |
+ "description": "If present, logo detection has completed successfully.", |
+ "items": { |
+ "$ref": "EntityAnnotation" |
+ }, |
+ "type": "array" |
}, |
- "description": { |
- "description": "Entity textual description, expressed in its `locale` language.", |
- "type": "string" |
+ "webDetection": { |
+ "$ref": "WebDetection", |
+ "description": "If present, web detection has completed successfully." |
}, |
- "properties": { |
- "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", |
+ "cropHintsAnnotation": { |
+ "$ref": "CropHintsAnnotation", |
+ "description": "If present, crop hints have completed successfully." |
+ }, |
+ "safeSearchAnnotation": { |
+ "$ref": "SafeSearchAnnotation", |
+ "description": "If present, safe-search annotation has completed successfully." |
+ }, |
+ "labelAnnotations": { |
+ "description": "If present, label detection has completed successfully.", |
"items": { |
- "$ref": "Property" |
+ "$ref": "EntityAnnotation" |
}, |
"type": "array" |
+ }, |
+ "error": { |
+ "$ref": "Status", |
+ "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." |
+ }, |
+ "fullTextAnnotation": { |
+ "$ref": "TextAnnotation", |
+ "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." |
} |
}, |
"type": "object" |
}, |
- "CropHint": { |
- "description": "Single crop hint that is used to generate a new crop when serving an image.", |
- "id": "CropHint", |
+ "CropHintsParams": { |
+ "description": "Parameters for crop hints annotation request.", |
+ "id": "CropHintsParams", |
"properties": { |
- "importanceFraction": { |
- "description": "Fraction of importance of this salient region with respect to the original\nimage.", |
- "format": "float", |
- "type": "number" |
- }, |
- "confidence": { |
- "description": "Confidence of this being a salient region. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
- }, |
- "boundingPoly": { |
- "$ref": "BoundingPoly", |
- "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`." |
+ "aspectRatios": { |
+ "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", |
+ "items": { |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "Landmark": { |
- "description": "A face-specific landmark (for example, a face feature).\nLandmark positions may fall outside the bounds of the image\nif the face is near one or more edges of the image.\nTherefore it is NOT guaranteed that `0 <= x < width` or\n`0 <= y < height`.", |
- "id": "Landmark", |
+ "Block": { |
+ "description": "Logical element on the page.", |
+ "id": "Block", |
"properties": { |
- "type": { |
- "description": "Face landmark type.", |
+ "property": { |
+ "$ref": "TextProperty", |
+ "description": "Additional information detected for the block." |
+ }, |
+ "blockType": { |
+ "description": "Detected block type (text, image etc) for this block.", |
"enum": [ |
- "UNKNOWN_LANDMARK", |
- "LEFT_EYE", |
- "RIGHT_EYE", |
- "LEFT_OF_LEFT_EYEBROW", |
- "RIGHT_OF_LEFT_EYEBROW", |
- "LEFT_OF_RIGHT_EYEBROW", |
- "RIGHT_OF_RIGHT_EYEBROW", |
- "MIDPOINT_BETWEEN_EYES", |
- "NOSE_TIP", |
- "UPPER_LIP", |
- "LOWER_LIP", |
- "MOUTH_LEFT", |
- "MOUTH_RIGHT", |
- "MOUTH_CENTER", |
- "NOSE_BOTTOM_RIGHT", |
- "NOSE_BOTTOM_LEFT", |
- "NOSE_BOTTOM_CENTER", |
- "LEFT_EYE_TOP_BOUNDARY", |
- "LEFT_EYE_RIGHT_CORNER", |
- "LEFT_EYE_BOTTOM_BOUNDARY", |
- "LEFT_EYE_LEFT_CORNER", |
- "RIGHT_EYE_TOP_BOUNDARY", |
- "RIGHT_EYE_RIGHT_CORNER", |
- "RIGHT_EYE_BOTTOM_BOUNDARY", |
- "RIGHT_EYE_LEFT_CORNER", |
- "LEFT_EYEBROW_UPPER_MIDPOINT", |
- "RIGHT_EYEBROW_UPPER_MIDPOINT", |
- "LEFT_EAR_TRAGION", |
- "RIGHT_EAR_TRAGION", |
- "LEFT_EYE_PUPIL", |
- "RIGHT_EYE_PUPIL", |
- "FOREHEAD_GLABELLA", |
- "CHIN_GNATHION", |
- "CHIN_LEFT_GONION", |
- "CHIN_RIGHT_GONION" |
+ "UNKNOWN", |
+ "TEXT", |
+ "TABLE", |
+ "PICTURE", |
+ "RULER", |
+ "BARCODE" |
], |
"enumDescriptions": [ |
- "Unknown face landmark detected. Should not be filled.", |
- "Left eye.", |
- "Right eye.", |
- "Left of left eyebrow.", |
- "Right of left eyebrow.", |
- "Left of right eyebrow.", |
- "Right of right eyebrow.", |
- "Midpoint between eyes.", |
- "Nose tip.", |
- "Upper lip.", |
- "Lower lip.", |
- "Mouth left.", |
- "Mouth right.", |
- "Mouth center.", |
- "Nose, bottom right.", |
- "Nose, bottom left.", |
- "Nose, bottom center.", |
- "Left eye, top boundary.", |
- "Left eye, right corner.", |
- "Left eye, bottom boundary.", |
- "Left eye, left corner.", |
- "Right eye, top boundary.", |
- "Right eye, right corner.", |
- "Right eye, bottom boundary.", |
- "Right eye, left corner.", |
- "Left eyebrow, upper midpoint.", |
- "Right eyebrow, upper midpoint.", |
- "Left ear tragion.", |
- "Right ear tragion.", |
- "Left eye pupil.", |
- "Right eye pupil.", |
- "Forehead glabella.", |
- "Chin gnathion.", |
- "Chin left gonion.", |
- "Chin right gonion." |
+ "Unknown block type.", |
+ "Regular text block.", |
+ "Table block.", |
+ "Image block.", |
+ "Horizontal/vertical line box.", |
+ "Barcode block." |
], |
"type": "string" |
}, |
- "position": { |
- "$ref": "Position", |
- "description": "Face landmark position." |
- } |
- }, |
- "type": "object" |
- }, |
- "WebImage": { |
- "description": "Metadata for online images.", |
- "id": "WebImage", |
- "properties": { |
- "score": { |
- "description": "Overall relevancy score for the image.\nNot normalized and not comparable across different image queries.", |
- "format": "float", |
- "type": "number" |
- }, |
- "url": { |
- "description": "The result image URL.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "Word": { |
- "description": "A word representation.", |
- "id": "Word", |
- "properties": { |
- "property": { |
- "$ref": "TextProperty", |
- "description": "Additional information detected for the word." |
- }, |
"boundingBox": { |
"$ref": "BoundingPoly", |
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
+ "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
}, |
- "symbols": { |
- "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", |
+ "paragraphs": { |
+ "description": "List of paragraphs in this block (if this blocks is of type text).", |
"items": { |
- "$ref": "Symbol" |
+ "$ref": "Paragraph" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "Paragraph": { |
- "description": "Structural unit of text representing a number of words in certain order.", |
- "id": "Paragraph", |
+ "WebDetection": { |
+ "description": "Relevant information for the image from the Internet.", |
+ "id": "WebDetection", |
"properties": { |
- "property": { |
- "$ref": "TextProperty", |
- "description": "Additional information detected for the paragraph." |
+ "fullMatchingImages": { |
+ "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", |
+ "items": { |
+ "$ref": "WebImage" |
+ }, |
+ "type": "array" |
}, |
- "boundingBox": { |
- "$ref": "BoundingPoly", |
- "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
+ "webEntities": { |
+ "description": "Deduced entities from similar images on the Internet.", |
+ "items": { |
+ "$ref": "WebEntity" |
+ }, |
+ "type": "array" |
}, |
- "words": { |
- "description": "List of words in this paragraph.", |
+ "pagesWithMatchingImages": { |
+ "description": "Web pages containing the matching images from the Internet.", |
"items": { |
- "$ref": "Word" |
+ "$ref": "WebPage" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "Image": { |
- "description": "Client image to perform Google Cloud Vision API tasks over.", |
- "id": "Image", |
- "properties": { |
- "source": { |
- "$ref": "ImageSource", |
- "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request." |
}, |
- "content": { |
- "description": "Image content, represented as a stream of bytes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.", |
- "format": "byte", |
- "type": "string" |
+ "visuallySimilarImages": { |
+ "description": "The visually similar image results.", |
+ "items": { |
+ "$ref": "WebImage" |
+ }, |
+ "type": "array" |
+ }, |
+ "partialMatchingImages": { |
+ "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", |
+ "items": { |
+ "$ref": "WebImage" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "FaceAnnotation": { |
- "description": "A face annotation object contains the results of face detection.", |
- "id": "FaceAnnotation", |
+ "BatchAnnotateImagesResponse": { |
+ "description": "Response to a batch image annotation request.", |
+ "id": "BatchAnnotateImagesResponse", |
"properties": { |
- "angerLikelihood": { |
- "description": "Anger likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
- "type": "string" |
- }, |
- "landmarks": { |
- "description": "Detected face landmarks.", |
+ "responses": { |
+ "description": "Individual responses to image annotation requests within the batch.", |
"items": { |
- "$ref": "Landmark" |
+ "$ref": "AnnotateImageResponse" |
}, |
"type": "array" |
- }, |
- "surpriseLikelihood": { |
- "description": "Surprise likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ImageSource": { |
+ "description": "External image source (Google Cloud Storage image location).", |
+ "id": "ImageSource", |
+ "properties": { |
+ "imageUri": { |
+ "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", |
"type": "string" |
}, |
- "landmarkingConfidence": { |
- "description": "Face landmarking confidence. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
- }, |
- "joyLikelihood": { |
- "description": "Joy likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
+ "gcsImageUri": { |
+ "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.", |
"type": "string" |
- }, |
- "detectionConfidence": { |
- "description": "Detection confidence. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
- }, |
- "panAngle": { |
- "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", |
- "format": "float", |
- "type": "number" |
- }, |
- "underExposedLikelihood": { |
- "description": "Under-exposed likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "LocationInfo": { |
+ "description": "Detected entity location information.", |
+ "id": "LocationInfo", |
+ "properties": { |
+ "latLng": { |
+ "$ref": "LatLng", |
+ "description": "lat/long location coordinates." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Property": { |
+ "description": "A `Property` consists of a user-supplied name/value pair.", |
+ "id": "Property", |
+ "properties": { |
+ "value": { |
+ "description": "Value of the property.", |
"type": "string" |
}, |
- "blurredLikelihood": { |
- "description": "Blurred likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
+ "uint64Value": { |
+ "description": "Value of numeric properties.", |
+ "format": "uint64", |
"type": "string" |
}, |
- "headwearLikelihood": { |
- "description": "Headwear likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
+ "name": { |
+ "description": "Name of the property.", |
"type": "string" |
- }, |
- "boundingPoly": { |
- "$ref": "BoundingPoly", |
- "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." |
- }, |
- "rollAngle": { |
- "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Position": { |
+ "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", |
+ "id": "Position", |
+ "properties": { |
+ "y": { |
+ "description": "Y coordinate.", |
"format": "float", |
"type": "number" |
}, |
- "sorrowLikelihood": { |
- "description": "Sorrow likelihood.", |
- "enum": [ |
- "UNKNOWN", |
- "VERY_UNLIKELY", |
- "UNLIKELY", |
- "POSSIBLE", |
- "LIKELY", |
- "VERY_LIKELY" |
- ], |
- "enumDescriptions": [ |
- "Unknown likelihood.", |
- "It is very unlikely that the image belongs to the specified vertical.", |
- "It is unlikely that the image belongs to the specified vertical.", |
- "It is possible that the image belongs to the specified vertical.", |
- "It is likely that the image belongs to the specified vertical.", |
- "It is very likely that the image belongs to the specified vertical." |
- ], |
- "type": "string" |
- }, |
- "tiltAngle": { |
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", |
+ "z": { |
+ "description": "Z coordinate (or depth).", |
"format": "float", |
"type": "number" |
}, |
- "fdBoundingPoly": { |
- "$ref": "BoundingPoly", |
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe <code>fd</code> (face detection) prefix." |
+ "x": { |
+ "description": "X coordinate.", |
+ "format": "float", |
+ "type": "number" |
} |
}, |
"type": "object" |
}, |
- "BatchAnnotateImagesRequest": { |
- "description": "Multiple image annotation requests are batched into a single service call.", |
- "id": "BatchAnnotateImagesRequest", |
+ "ColorInfo": { |
+ "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", |
+ "id": "ColorInfo", |
"properties": { |
- "requests": { |
- "description": "Individual image annotation requests for this batch.", |
- "items": { |
- "$ref": "AnnotateImageRequest" |
- }, |
- "type": "array" |
+ "score": { |
+ "description": "Image-specific score for this color. Value in range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "pixelFraction": { |
+ "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "color": { |
+ "$ref": "Color", |
+ "description": "RGB components of the color." |
} |
}, |
"type": "object" |
}, |
- "DetectedBreak": { |
- "description": "Detected start or end of a structural component.", |
- "id": "DetectedBreak", |
+ "WebPage": { |
+ "description": "Metadata for web pages.", |
+ "id": "WebPage", |
"properties": { |
- "type": { |
- "description": "Detected break type.", |
- "enum": [ |
- "UNKNOWN", |
- "SPACE", |
- "SURE_SPACE", |
- "EOL_SURE_SPACE", |
- "HYPHEN", |
- "LINE_BREAK" |
- ], |
- "enumDescriptions": [ |
- "Unknown break label type.", |
- "Regular space.", |
- "Sure space (very wide).", |
- "Line-wrapping break.", |
- "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", |
- "Line break that ends a paragraph." |
- ], |
- "type": "string" |
+ "score": { |
+ "description": "Overall relevancy score for the web page.\nNot normalized and not comparable across different image queries.", |
+ "format": "float", |
+ "type": "number" |
}, |
- "isPrefix": { |
- "description": "True if break prepends the element.", |
- "type": "boolean" |
+ "url": { |
+ "description": "The result web page URL.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "ImageContext": { |
- "description": "Image context and/or feature-specific parameters.", |
- "id": "ImageContext", |
+ "EntityAnnotation": { |
+ "description": "Set of detected entity features.", |
+ "id": "EntityAnnotation", |
"properties": { |
- "latLongRect": { |
- "$ref": "LatLongRect", |
- "description": "lat/long rectangle that specifies the location of the image." |
- }, |
- "cropHintsParams": { |
- "$ref": "CropHintsParams", |
- "description": "Parameters for crop hints annotation request." |
+ "score": { |
+ "description": "Overall score of the result. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
}, |
- "languageHints": { |
- "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).", |
+ "locations": { |
+ "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", |
"items": { |
- "type": "string" |
+ "$ref": "LocationInfo" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "Page": { |
- "description": "Detected page from OCR.", |
- "id": "Page", |
- "properties": { |
- "height": { |
- "description": "Page height in pixels.", |
- "format": "int32", |
- "type": "integer" |
}, |
- "width": { |
- "description": "Page width in pixels.", |
- "format": "int32", |
- "type": "integer" |
+ "mid": { |
+ "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", |
+ "type": "string" |
}, |
- "blocks": { |
- "description": "List of blocks of text, images etc on this page.", |
+ "confidence": { |
+ "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "boundingPoly": { |
+ "$ref": "BoundingPoly", |
+ "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." |
+ }, |
+ "locale": { |
+ "description": "The language code for the locale in which the entity textual\n`description` is expressed.", |
+ "type": "string" |
+ }, |
+ "description": { |
+ "description": "Entity textual description, expressed in its `locale` language.", |
+ "type": "string" |
+ }, |
+ "topicality": { |
+ "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "properties": { |
+ "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", |
"items": { |
- "$ref": "Block" |
+ "$ref": "Property" |
}, |
"type": "array" |
- }, |
- "property": { |
- "$ref": "TextProperty", |
- "description": "Additional information detected on the page." |
} |
}, |
"type": "object" |
}, |
- "AnnotateImageRequest": { |
- "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.", |
- "id": "AnnotateImageRequest", |
+ "CropHint": { |
+ "description": "Single crop hint that is used to generate a new crop when serving an image.", |
+ "id": "CropHint", |
"properties": { |
- "features": { |
- "description": "Requested features.", |
- "items": { |
- "$ref": "Feature" |
- }, |
- "type": "array" |
+ "importanceFraction": { |
+ "description": "Fraction of importance of this salient region with respect to the original\nimage.", |
+ "format": "float", |
+ "type": "number" |
}, |
- "image": { |
- "$ref": "Image", |
- "description": "The image to be processed." |
+ "confidence": { |
+ "description": "Confidence of this being a salient region. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
}, |
- "imageContext": { |
- "$ref": "ImageContext", |
- "description": "Additional context that may accompany the image." |
+ "boundingPoly": { |
+ "$ref": "BoundingPoly", |
+ "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`." |
} |
}, |
"type": "object" |
}, |
- "Status": { |
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
- "id": "Status", |
+ "Landmark": { |
+ "description": "A face-specific landmark (for example, a face feature).\nLandmark positions may fall outside the bounds of the image\nif the face is near one or more edges of the image.\nTherefore it is NOT guaranteed that `0 <= x < width` or\n`0 <= y < height`.", |
+ "id": "Landmark", |
"properties": { |
- "message": { |
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
- "type": "string" |
+ "position": { |
+ "$ref": "Position", |
+ "description": "Face landmark position." |
}, |
- "details": { |
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
- "items": { |
- "additionalProperties": { |
- "description": "Properties of the object. Contains field @type with type URL.", |
- "type": "any" |
- }, |
- "type": "object" |
- }, |
- "type": "array" |
+ "type": { |
+ "description": "Face landmark type.", |
+ "enum": [ |
+ "UNKNOWN_LANDMARK", |
+ "LEFT_EYE", |
+ "RIGHT_EYE", |
+ "LEFT_OF_LEFT_EYEBROW", |
+ "RIGHT_OF_LEFT_EYEBROW", |
+ "LEFT_OF_RIGHT_EYEBROW", |
+ "RIGHT_OF_RIGHT_EYEBROW", |
+ "MIDPOINT_BETWEEN_EYES", |
+ "NOSE_TIP", |
+ "UPPER_LIP", |
+ "LOWER_LIP", |
+ "MOUTH_LEFT", |
+ "MOUTH_RIGHT", |
+ "MOUTH_CENTER", |
+ "NOSE_BOTTOM_RIGHT", |
+ "NOSE_BOTTOM_LEFT", |
+ "NOSE_BOTTOM_CENTER", |
+ "LEFT_EYE_TOP_BOUNDARY", |
+ "LEFT_EYE_RIGHT_CORNER", |
+ "LEFT_EYE_BOTTOM_BOUNDARY", |
+ "LEFT_EYE_LEFT_CORNER", |
+ "RIGHT_EYE_TOP_BOUNDARY", |
+ "RIGHT_EYE_RIGHT_CORNER", |
+ "RIGHT_EYE_BOTTOM_BOUNDARY", |
+ "RIGHT_EYE_LEFT_CORNER", |
+ "LEFT_EYEBROW_UPPER_MIDPOINT", |
+ "RIGHT_EYEBROW_UPPER_MIDPOINT", |
+ "LEFT_EAR_TRAGION", |
+ "RIGHT_EAR_TRAGION", |
+ "LEFT_EYE_PUPIL", |
+ "RIGHT_EYE_PUPIL", |
+ "FOREHEAD_GLABELLA", |
+ "CHIN_GNATHION", |
+ "CHIN_LEFT_GONION", |
+ "CHIN_RIGHT_GONION" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown face landmark detected. Should not be filled.", |
+ "Left eye.", |
+ "Right eye.", |
+ "Left of left eyebrow.", |
+ "Right of left eyebrow.", |
+ "Left of right eyebrow.", |
+ "Right of right eyebrow.", |
+ "Midpoint between eyes.", |
+ "Nose tip.", |
+ "Upper lip.", |
+ "Lower lip.", |
+ "Mouth left.", |
+ "Mouth right.", |
+ "Mouth center.", |
+ "Nose, bottom right.", |
+ "Nose, bottom left.", |
+ "Nose, bottom center.", |
+ "Left eye, top boundary.", |
+ "Left eye, right corner.", |
+ "Left eye, bottom boundary.", |
+ "Left eye, left corner.", |
+ "Right eye, top boundary.", |
+ "Right eye, right corner.", |
+ "Right eye, bottom boundary.", |
+ "Right eye, left corner.", |
+ "Left eyebrow, upper midpoint.", |
+ "Right eyebrow, upper midpoint.", |
+ "Left ear tragion.", |
+ "Right ear tragion.", |
+ "Left eye pupil.", |
+ "Right eye pupil.", |
+ "Forehead glabella.", |
+ "Chin gnathion.", |
+ "Chin left gonion.", |
+ "Chin right gonion." |
+ ], |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "WebImage": { |
+ "description": "Metadata for online images.", |
+ "id": "WebImage", |
+ "properties": { |
+ "score": { |
+ "description": "Overall relevancy score for the image.\nNot normalized and not comparable across different image queries.", |
+ "format": "float", |
+ "type": "number" |
}, |
- "code": { |
- "description": "The status code, which should be an enum value of google.rpc.Code.", |
- "format": "int32", |
- "type": "integer" |
+ "url": { |
+ "description": "The result image URL.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "Symbol": { |
- "description": "A single symbol representation.", |
- "id": "Symbol", |
+ "Word": { |
+ "description": "A word representation.", |
+ "id": "Word", |
"properties": { |
"property": { |
"$ref": "TextProperty", |
- "description": "Additional information detected for the symbol." |
+ "description": "Additional information detected for the word." |
}, |
"boundingBox": { |
"$ref": "BoundingPoly", |
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
+ "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
}, |
- "text": { |
- "description": "The actual UTF-8 representation of the symbol.", |
- "type": "string" |
+ "symbols": { |
+ "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", |
+ "items": { |
+ "$ref": "Symbol" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "LatLongRect": { |
- "description": "Rectangle determined by min and max `LatLng` pairs.", |
- "id": "LatLongRect", |
+ "Image": { |
+ "description": "Client image to perform Google Cloud Vision API tasks over.", |
+ "id": "Image", |
"properties": { |
- "minLatLng": { |
- "$ref": "LatLng", |
- "description": "Min lat/long pair." |
+ "source": { |
+ "$ref": "ImageSource", |
+ "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request." |
}, |
- "maxLatLng": { |
- "$ref": "LatLng", |
- "description": "Max lat/long pair." |
+ "content": { |
+ "description": "Image content, represented as a stream of bytes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.", |
+ "format": "byte", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "CropHintsAnnotation": { |
- "description": "Set of crop hints that are used to generate new crops when serving images.", |
- "id": "CropHintsAnnotation", |
+ "Paragraph": { |
+ "description": "Structural unit of text representing a number of words in certain order.", |
+ "id": "Paragraph", |
"properties": { |
- "cropHints": { |
- "description": "Crop hint results.", |
+ "words": { |
+ "description": "List of words in this paragraph.", |
"items": { |
- "$ref": "CropHint" |
+ "$ref": "Word" |
}, |
"type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "LatLng": { |
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)", |
- "id": "LatLng", |
- "properties": { |
- "longitude": { |
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", |
- "format": "double", |
- "type": "number" |
}, |
- "latitude": { |
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", |
- "format": "double", |
- "type": "number" |
+ "property": { |
+ "$ref": "TextProperty", |
+ "description": "Additional information detected for the paragraph." |
+ }, |
+ "boundingBox": { |
+ "$ref": "BoundingPoly", |
+ "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
} |
}, |
"type": "object" |
}, |
- "Color": { |
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", |
- "id": "Color", |
+ "FaceAnnotation": { |
+ "description": "A face annotation object contains the results of face detection.", |
+ "id": "FaceAnnotation", |
"properties": { |
- "alpha": { |
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", |
- "format": "float", |
- "type": "number" |
+ "surpriseLikelihood": { |
+ "description": "Surprise likelihood.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
+ ], |
+ "type": "string" |
}, |
- "blue": { |
- "description": "The amount of blue in the color as a value in the interval [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "landmarks": { |
+ "description": "Detected face landmarks.", |
+ "items": { |
+ "$ref": "Landmark" |
+ }, |
+ "type": "array" |
}, |
- "green": { |
- "description": "The amount of green in the color as a value in the interval [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "angerLikelihood": { |
+ "description": "Anger likelihood.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
+ ], |
+ "type": "string" |
}, |
- "red": { |
- "description": "The amount of red in the color as a value in the interval [0, 1].", |
+ "landmarkingConfidence": { |
+ "description": "Face landmarking confidence. Range [0, 1].", |
"format": "float", |
"type": "number" |
- } |
- }, |
- "type": "object" |
- }, |
- "ImageProperties": { |
- "description": "Stores image properties, such as dominant colors.", |
- "id": "ImageProperties", |
- "properties": { |
- "dominantColors": { |
- "$ref": "DominantColorsAnnotation", |
- "description": "If present, dominant colors completed successfully." |
- } |
- }, |
- "type": "object" |
- }, |
- "Feature": { |
- "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.", |
- "id": "Feature", |
- "properties": { |
- "maxResults": { |
- "description": "Maximum number of results of this type.", |
- "format": "int32", |
- "type": "integer" |
}, |
- "type": { |
- "description": "The feature type.", |
+ "joyLikelihood": { |
+ "description": "Joy likelihood.", |
"enum": [ |
- "TYPE_UNSPECIFIED", |
- "FACE_DETECTION", |
- "LANDMARK_DETECTION", |
- "LOGO_DETECTION", |
- "LABEL_DETECTION", |
- "TEXT_DETECTION", |
- "DOCUMENT_TEXT_DETECTION", |
- "SAFE_SEARCH_DETECTION", |
- "IMAGE_PROPERTIES", |
- "CROP_HINTS", |
- "WEB_DETECTION" |
+ "UNKNOWN", |
+ "VERY_UNLIKELY", |
+ "UNLIKELY", |
+ "POSSIBLE", |
+ "LIKELY", |
+ "VERY_LIKELY" |
], |
"enumDescriptions": [ |
- "Unspecified feature type.", |
- "Run face detection.", |
- "Run landmark detection.", |
- "Run logo detection.", |
- "Run label detection.", |
- "Run OCR.", |
- "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.", |
- "Run computer vision models to compute image safe-search properties.", |
- "Compute a set of image properties, such as the image's dominant colors.", |
- "Run crop hints.", |
- "Run web detection." |
+ "Unknown likelihood.", |
+ "It is very unlikely that the image belongs to the specified vertical.", |
+ "It is unlikely that the image belongs to the specified vertical.", |
+ "It is possible that the image belongs to the specified vertical.", |
+ "It is likely that the image belongs to the specified vertical.", |
+ "It is very likely that the image belongs to the specified vertical." |
], |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "SafeSearchAnnotation": { |
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", |
- "id": "SafeSearchAnnotation", |
- "properties": { |
- "spoof": { |
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", |
+ }, |
+ "underExposedLikelihood": { |
+ "description": "Under-exposed likelihood.", |
"enum": [ |
"UNKNOWN", |
"VERY_UNLIKELY", |
@@ -1165,8 +1018,18 @@ |
], |
"type": "string" |
}, |
- "medical": { |
- "description": "Likelihood that this is a medical image.", |
+ "panAngle": { |
+ "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "detectionConfidence": { |
+ "description": "Detection confidence. Range [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "blurredLikelihood": { |
+ "description": "Blurred likelihood.", |
"enum": [ |
"UNKNOWN", |
"VERY_UNLIKELY", |
@@ -1185,8 +1048,8 @@ |
], |
"type": "string" |
}, |
- "violence": { |
- "description": "Violence likelihood.", |
+ "headwearLikelihood": { |
+ "description": "Headwear likelihood.", |
"enum": [ |
"UNKNOWN", |
"VERY_UNLIKELY", |
@@ -1205,8 +1068,17 @@ |
], |
"type": "string" |
}, |
- "adult": { |
- "description": "Represents the adult content likelihood for the image.", |
+ "boundingPoly": { |
+ "$ref": "BoundingPoly", |
+ "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." |
+ }, |
+ "rollAngle": { |
+ "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "sorrowLikelihood": { |
+ "description": "Sorrow likelihood.", |
"enum": [ |
"UNKNOWN", |
"VERY_UNLIKELY", |
@@ -1224,121 +1096,249 @@ |
"It is very likely that the image belongs to the specified vertical." |
], |
"type": "string" |
+ }, |
+ "tiltAngle": { |
+ "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "fdBoundingPoly": { |
+ "$ref": "BoundingPoly", |
+ "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe <code>fd</code> (face detection) prefix." |
} |
}, |
"type": "object" |
}, |
- "DominantColorsAnnotation": { |
- "description": "Set of dominant colors and their corresponding scores.", |
- "id": "DominantColorsAnnotation", |
+ "BatchAnnotateImagesRequest": { |
+ "description": "Multiple image annotation requests are batched into a single service call.", |
+ "id": "BatchAnnotateImagesRequest", |
"properties": { |
- "colors": { |
- "description": "RGB color values with their score and pixel fraction.", |
+ "requests": { |
+ "description": "Individual image annotation requests for this batch.", |
"items": { |
- "$ref": "ColorInfo" |
+ "$ref": "AnnotateImageRequest" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "TextAnnotation": { |
- "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\nrefer to the google.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for more detail.", |
- "id": "TextAnnotation", |
+ "DetectedBreak": { |
+ "description": "Detected start or end of a structural component.", |
+ "id": "DetectedBreak", |
"properties": { |
- "pages": { |
- "description": "List of pages detected by OCR.", |
+ "type": { |
+ "description": "Detected break type.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "SPACE", |
+ "SURE_SPACE", |
+ "EOL_SURE_SPACE", |
+ "HYPHEN", |
+ "LINE_BREAK" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown break label type.", |
+ "Regular space.", |
+ "Sure space (very wide).", |
+ "Line-wrapping break.", |
+ "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", |
+ "Line break that ends a paragraph." |
+ ], |
+ "type": "string" |
+ }, |
+ "isPrefix": { |
+ "description": "True if break prepends the element.", |
+ "type": "boolean" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ImageContext": { |
+ "description": "Image context and/or feature-specific parameters.", |
+ "id": "ImageContext", |
+ "properties": { |
+ "cropHintsParams": { |
+ "$ref": "CropHintsParams", |
+ "description": "Parameters for crop hints annotation request." |
+ }, |
+ "languageHints": { |
+ "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).", |
"items": { |
- "$ref": "Page" |
+ "type": "string" |
}, |
"type": "array" |
}, |
- "text": { |
- "description": "UTF-8 text detected on the pages.", |
- "type": "string" |
+ "latLongRect": { |
+ "$ref": "LatLongRect", |
+ "description": "lat/long rectangle that specifies the location of the image." |
} |
}, |
"type": "object" |
}, |
- "Vertex": { |
- "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", |
- "id": "Vertex", |
+ "Page": { |
+ "description": "Detected page from OCR.", |
+ "id": "Page", |
"properties": { |
- "y": { |
- "description": "Y coordinate.", |
+ "height": { |
+ "description": "Page height in pixels.", |
"format": "int32", |
"type": "integer" |
}, |
- "x": { |
- "description": "X coordinate.", |
+ "width": { |
+ "description": "Page width in pixels.", |
"format": "int32", |
"type": "integer" |
+ }, |
+ "blocks": { |
+ "description": "List of blocks of text, images etc on this page.", |
+ "items": { |
+ "$ref": "Block" |
+ }, |
+ "type": "array" |
+ }, |
+ "property": { |
+ "$ref": "TextProperty", |
+ "description": "Additional information detected on the page." |
} |
}, |
"type": "object" |
}, |
- "DetectedLanguage": { |
- "description": "Detected language for a structural component.", |
- "id": "DetectedLanguage", |
+ "AnnotateImageRequest": { |
+ "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.", |
+ "id": "AnnotateImageRequest", |
"properties": { |
- "languageCode": { |
- "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", |
- "type": "string" |
+ "features": { |
+ "description": "Requested features.", |
+ "items": { |
+ "$ref": "Feature" |
+ }, |
+ "type": "array" |
}, |
- "confidence": { |
- "description": "Confidence of detected language. Range [0, 1].", |
- "format": "float", |
- "type": "number" |
+ "image": { |
+ "$ref": "Image", |
+ "description": "The image to be processed." |
+ }, |
+ "imageContext": { |
+ "$ref": "ImageContext", |
+ "description": "Additional context that may accompany the image." |
} |
}, |
"type": "object" |
}, |
- "TextProperty": { |
- "description": "Additional information detected on the structural component.", |
- "id": "TextProperty", |
+ "Status": { |
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", |
+ "id": "Status", |
"properties": { |
- "detectedBreak": { |
- "$ref": "DetectedBreak", |
- "description": "Detected start or end of a text segment." |
+ "code": { |
+ "description": "The status code, which should be an enum value of google.rpc.Code.", |
+ "format": "int32", |
+ "type": "integer" |
}, |
- "detectedLanguages": { |
- "description": "A list of detected languages together with confidence.", |
+ "message": { |
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
+ "type": "string" |
+ }, |
+ "details": { |
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
"items": { |
- "$ref": "DetectedLanguage" |
+ "additionalProperties": { |
+ "description": "Properties of the object. Contains field @type with type URL.", |
+ "type": "any" |
+ }, |
+ "type": "object" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "BoundingPoly": { |
- "description": "A bounding polygon for the detected image annotation.", |
- "id": "BoundingPoly", |
+ "LatLongRect": { |
+ "description": "Rectangle determined by min and max `LatLng` pairs.", |
+ "id": "LatLongRect", |
"properties": { |
- "vertices": { |
- "description": "The bounding polygon vertices.", |
+ "maxLatLng": { |
+ "$ref": "LatLng", |
+ "description": "Max lat/long pair." |
+ }, |
+ "minLatLng": { |
+ "$ref": "LatLng", |
+ "description": "Min lat/long pair." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Symbol": { |
+ "description": "A single symbol representation.", |
+ "id": "Symbol", |
+ "properties": { |
+ "text": { |
+ "description": "The actual UTF-8 representation of the symbol.", |
+ "type": "string" |
+ }, |
+ "property": { |
+ "$ref": "TextProperty", |
+ "description": "Additional information detected for the symbol." |
+ }, |
+ "boundingBox": { |
+ "$ref": "BoundingPoly", |
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "CropHintsAnnotation": { |
+ "description": "Set of crop hints that are used to generate new crops when serving images.", |
+ "id": "CropHintsAnnotation", |
+ "properties": { |
+ "cropHints": { |
+ "description": "Crop hint results.", |
"items": { |
- "$ref": "Vertex" |
+ "$ref": "CropHint" |
}, |
"type": "array" |
} |
}, |
"type": "object" |
}, |
- "WebEntity": { |
- "description": "Entity deduced from similar images on the Internet.", |
- "id": "WebEntity", |
+ "LatLng": { |
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\">WGS84\nstandard</a>. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r > 180.0 or (r == 180.0 and q <= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r <= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r >= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)", |
+ "id": "LatLng", |
"properties": { |
- "entityId": { |
- "description": "Opaque entity ID.", |
- "type": "string" |
+ "latitude": { |
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", |
+ "format": "double", |
+ "type": "number" |
}, |
- "description": { |
- "description": "Canonical description of the entity, in English.", |
- "type": "string" |
+ "longitude": { |
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", |
+ "format": "double", |
+ "type": "number" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Color": { |
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha <= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red << 16) | (green << 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i < missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", |
+ "id": "Color", |
+ "properties": { |
+ "alpha": { |
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", |
+ "format": "float", |
+ "type": "number" |
}, |
- "score": { |
- "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", |
+ "blue": { |
+ "description": "The amount of blue in the color as a value in the interval [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "green": { |
+ "description": "The amount of green in the color as a value in the interval [0, 1].", |
+ "format": "float", |
+ "type": "number" |
+ }, |
+ "red": { |
+ "description": "The amount of red in the color as a value in the interval [0, 1].", |
"format": "float", |
"type": "number" |
} |