{ "protocol": "rest", "batchPath": "batch", "rootUrl": "https://vision.googleapis.com/", "baseUrl": "https://vision.googleapis.com/", "version": "v1p2beta1", "schemas": { "GoogleCloudVisionV1p1beta1Block": { "properties": { "blockType": { "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "type": "string" }, "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected for the block." }, "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results on the block. Range [0, 1]." }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Paragraph" } } }, "id": "GoogleCloudVisionV1p1beta1Block", "description": "Logical element on the page.", "type": "object" }, "GoogleCloudVisionV1p1beta1Symbol": { "properties": { "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "type": "number", "format": "float" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } }, "id": "GoogleCloudVisionV1p1beta1Symbol", "description": "A single symbol representation.", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebEntity": { "properties": { "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "score": { "type": "number", "format": "float", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries." }, "entityId": { "description": "Opaque entity ID.", "type": "string" } }, "description": "Entity deduced from similar images on the Internet.", "type": "object", "id": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity" }, "GoogleCloudVisionV1p1beta1GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "id": "GoogleCloudVisionV1p1beta1GcsDestination", "type": "object", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1AnnotateImageResponse": { "id": "GoogleCloudVisionV1p2beta1AnnotateImageResponse", "description": "Response to an image annotation request.", "properties": { "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "labelAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "type": "array", "description": "If present, label detection has completed successfully." }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1WebDetection" }, "context": { "$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResults" }, "logoAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "type": "array", "description": "If present, logo detection has completed successfully." }, "textAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "type": "array", "description": "If present, text (OCR) detection has completed successfully." }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotation" } }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation" }, "localizedObjectAnnotations": { "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" }, "type": "array" }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1ImageProperties", "description": "If present, image properties were extracted successfully." }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotation", "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." } }, "type": "object" }, "AnnotateFileResponse": { "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "type": "object", "properties": { "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "InputConfig" }, "responses": { "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "AnnotateImageResponse" }, "type": "array" }, "error": { "$ref": "Status", "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." } }, "id": "AnnotateFileResponse" }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { "properties": { "pageNumber": { "type": "integer", "format": "int32", "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image." }, "uri": { "type": "string", "description": "The URI of the file used to produce the image." } }, "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext", "type": "object" }, "GoogleCloudVisionV1p1beta1ProductKeyValue": { "id": "GoogleCloudVisionV1p1beta1ProductKeyValue", "type": "object", "properties": { "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." } }, "description": "A product label represented as a key-value pair." }, "GoogleCloudVisionV1p4beta1WebDetectionWebPage": { "properties": { "url": { "description": "The result web page URL.", "type": "string" }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image.", "type": "array" }, "partialMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "type": "array" }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" } }, "type": "object", "description": "Metadata for web pages.", "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage" }, "GoogleCloudVisionV1p1beta1EntityAnnotation": { "properties": { "topicality": { "type": "number", "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float" }, "locations": { "type": "array", "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocationInfo" } }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "confidence": { "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "type": "number", "format": "float", "deprecated": true }, "score": { "format": "float", "description": "Overall score of the result. Range [0, 1].", "type": "number" }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "properties": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" }, "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "type": "array" }, "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." } }, "id": "GoogleCloudVisionV1p1beta1EntityAnnotation", "type": "object", "description": "Set of detected entity features." }, "GoogleCloudVisionV1p3beta1WebDetection": { "description": "Relevant information for the image from the Internet.", "id": "GoogleCloudVisionV1p3beta1WebDetection", "type": "object", "properties": { "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops." }, "visuallySimilarImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "The visually similar image results." }, "bestGuessLabels": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "type": "array" }, "webEntities": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity" }, "description": "Deduced entities from similar images on the Internet." }, "pagesWithMatchingImages": { "type": "array", "description": "Web pages containing the matching images from the Internet.", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebPage" } } } }, "GoogleCloudVisionV1p2beta1Product": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Product", "description": "A Product contains ReferenceImages.", "properties": { "productCategory": { "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." }, "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { "type": "string", "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product." }, "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." } } }, "WebImage": { "description": "Metadata for online images.", "id": "WebImage", "type": "object", "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p4beta1LocationInfo": { "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "description": "Detected entity location information.", "type": "object", "id": "GoogleCloudVisionV1p4beta1LocationInfo" }, "GoogleCloudVisionV1p4beta1FaceRecognitionResult": { "description": "Information about a face's identity.", "id": "GoogleCloudVisionV1p4beta1FaceRecognitionResult", "properties": { "celebrity": { "$ref": "GoogleCloudVisionV1p4beta1Celebrity", "description": "The Celebrity that this face was matched to." }, "confidence": { "type": "number", "description": "Recognition confidence. Range [0, 1].", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest": { "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest", "description": "A list of requests to annotate files using the BatchAnnotateFiles API.", "properties": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", "additionalProperties": { "type": "string" } }, "requests": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileRequest" }, "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest." } }, "type": "object" }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { "properties": { "x": { "type": "number", "format": "float", "description": "X coordinate." }, "y": { "format": "float", "description": "Y coordinate.", "type": "number" } }, "id": "GoogleCloudVisionV1p3beta1NormalizedVertex", "type": "object", "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1." }, "GroupedResult": { "description": "Information about the products similar to a single product in a query image.", "type": "object", "properties": { "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "items": { "$ref": "ObjectAnnotation" }, "type": "array" }, "results": { "description": "List of results, one for each product match.", "items": { "$ref": "Result" }, "type": "array" }, "boundingPoly": { "$ref": "BoundingPoly", "description": "The bounding polygon around the product detected in the query image." } }, "id": "GroupedResult" }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "properties": { "uri": { "type": "string", "description": "The URI of the file used to produce the image." }, "pageNumber": { "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "type": "object" }, "GoogleCloudVisionV1p2beta1CropHint": { "id": "GoogleCloudVisionV1p2beta1CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" }, "confidence": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1Feature": { "properties": { "maxResults": { "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "type": "integer", "format": "int32" }, "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", "PRODUCT_SEARCH", "OBJECT_LOCALIZATION" ], "description": "The feature type.", "enumDescriptions": [ "Unspecified feature type.", "Run face detection.", "Run landmark detection.", "Run logo detection.", "Run label detection.", "Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.", "Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", "Run Safe Search to detect potentially unsafe or undesirable content.", "Compute a set of image properties, such as the image's dominant colors.", "Run crop hints.", "Run web detection.", "Run Product Search.", "Run localizer for object detection." ], "type": "string" }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/rc\" for the latest release candidate." } }, "description": "The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list.", "type": "object", "id": "GoogleCloudVisionV1p2beta1Feature" }, "GoogleCloudVisionV1p4beta1WebDetectionWebImage": { "type": "object", "description": "Metadata for online images.", "properties": { "score": { "type": "number", "format": "float", "description": "(Deprecated) Overall relevancy score for the image." }, "url": { "type": "string", "description": "The result image URL." } }, "id": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "GoogleCloudVisionV1p4beta1CropHint": { "type": "object", "id": "GoogleCloudVisionV1p4beta1CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { "format": "float", "type": "number", "description": "Confidence of this being a salient region. Range [0, 1]." }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "type": "number", "format": "float" } } }, "Operation": { "type": "object", "properties": { "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation" }, "LocalizedObjectAnnotation": { "id": "LocalizedObjectAnnotation", "description": "Set of detected objects with bounding boxes.", "type": "object", "properties": { "name": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "BoundingPoly" }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" } } }, "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": { "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "properties": { "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak" }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage" } } }, "type": "object", "description": "Additional information detected on the structural component." }, "Result": { "description": "Information about a product.", "id": "Result", "type": "object", "properties": { "product": { "$ref": "Product", "description": "The Product." }, "score": { "type": "number", "format": "float", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence)." }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation": { "type": "object", "description": "Set of detected objects with bounding boxes.", "id": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation", "properties": { "score": { "format": "float", "type": "number", "description": "Score of the result. Range [0, 1]." }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "Image region to which this object belongs. This must be populated." } } }, "GoogleCloudVisionV1p3beta1Product": { "description": "A Product contains ReferenceImages.", "id": "GoogleCloudVisionV1p3beta1Product", "type": "object", "properties": { "productCategory": { "type": "string", "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products." }, "displayName": { "type": "string", "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long." }, "name": { "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "description": { "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "productLabels": { "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, "type": "array", "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." } } }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "objectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation" }, "description": "List of generic predictions for the object in the bounding box.", "type": "array" } }, "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult", "description": "Information about the products similar to a single product in a query image." }, "GoogleCloudVisionV1p2beta1Symbol": { "description": "A single symbol representation.", "type": "object", "id": "GoogleCloudVisionV1p2beta1Symbol", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float" }, "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected for the symbol." }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "type": "array" } }, "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse", "type": "object", "description": "Response to an async batch file annotation request." }, "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse": { "type": "object", "id": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse", "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p4beta1OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } }, "description": "The response for a single offline file annotation request." }, "GoogleCloudVisionV1p1beta1FaceAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p1beta1FaceAnnotation", "description": "A face annotation object contains the results of face detection.", "properties": { "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Headwear likelihood." }, "blurredLikelihood": { "type": "string", "description": "Blurred likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "sorrowLikelihood": { "description": "Sorrow likelihood.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "panAngle": { "format": "float", "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "type": "number" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "angerLikelihood": { "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "landmarks": { "items": { "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks.", "type": "array" }, "detectionConfidence": { "format": "float", "type": "number", "description": "Detection confidence. Range [0, 1]." }, "rollAngle": { "type": "number", "format": "float", "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]." }, "tiltAngle": { "format": "float", "type": "number", "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]." }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "surpriseLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Surprise likelihood.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "underExposedLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "landmarkingConfidence": { "format": "float", "description": "Face landmarking confidence. Range [0, 1].", "type": "number" }, "joyLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Joy likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" } } }, "GoogleCloudVisionV1p3beta1ProductSearchResults": { "id": "GoogleCloudVisionV1p3beta1ProductSearchResults", "description": "Results for a product search request.", "properties": { "results": { "type": "array", "description": "List of results, one for each product match.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" } }, "indexTime": { "type": "string", "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime" }, "productGroupedResults": { "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" }, "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "type": "array" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ProductSearchResults": { "properties": { "indexTime": { "type": "string", "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "format": "google-datetime" }, "productGroupedResults": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" }, "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results." }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." } }, "description": "Results for a product search request.", "type": "object", "id": "GoogleCloudVisionV1p4beta1ProductSearchResults" }, "EntityAnnotation": { "properties": { "properties": { "items": { "$ref": "Property" }, "type": "array", "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity." }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "topicality": { "type": "number", "format": "float", "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]." }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "locations": { "type": "array", "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.", "items": { "$ref": "LocationInfo" } }, "confidence": { "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "deprecated": true, "type": "number", "format": "float" }, "score": { "description": "Overall score of the result. Range [0, 1].", "type": "number", "format": "float" }, "boundingPoly": { "$ref": "BoundingPoly", "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." } }, "id": "EntityAnnotation", "description": "Set of detected entity features.", "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileRequest": { "type": "object", "description": "A request to annotate one single file, e.g. a PDF, TIFF or GIF file.", "properties": { "features": { "description": "Required. Requested features.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "type": "array" }, "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "pages": { "description": "Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "inputConfig": { "description": "Required. Information about the input file.", "$ref": "GoogleCloudVisionV1p2beta1InputConfig" } }, "id": "GoogleCloudVisionV1p2beta1AnnotateFileRequest" }, "GoogleCloudVisionV1p2beta1OutputConfig": { "description": "The desired output location and metadata.", "id": "GoogleCloudVisionV1p2beta1OutputConfig", "type": "object", "properties": { "batchSize": { "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, "gcsDestination": { "$ref": "GoogleCloudVisionV1p2beta1GcsDestination", "description": "The Google Cloud Storage location to write the output(s) to." } } }, "GoogleCloudVisionV1p3beta1TextAnnotation": { "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p3beta1TextAnnotation", "type": "object", "properties": { "pages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Page" }, "description": "List of pages detected by OCR.", "type": "array" }, "text": { "description": "UTF-8 text detected on the pages.", "type": "string" } } }, "AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "items": { "$ref": "AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "description": "Response to an async batch file annotation request.", "type": "object", "id": "AsyncBatchAnnotateFilesResponse" }, "OperationMetadata": { "type": "object", "properties": { "createTime": { "description": "The time when the batch request was received.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ], "description": "Current state of the batch operation.", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ] } }, "description": "Contains metadata for the BatchAnnotateImages operation.", "id": "OperationMetadata" }, "GoogleCloudVisionV1p2beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "properties": { "vertices": { "type": "array", "description": "The bounding polygon vertices.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Vertex" } }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1NormalizedVertex" } } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "GoogleCloudVisionV1p2beta1LocationInfo": { "id": "GoogleCloudVisionV1p2beta1LocationInfo", "type": "object", "description": "Detected entity location information.", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } } }, "GoogleCloudVisionV1p4beta1OutputConfig": { "type": "object", "description": "The desired output location and metadata.", "id": "GoogleCloudVisionV1p4beta1OutputConfig", "properties": { "batchSize": { "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "format": "int32", "type": "integer" }, "gcsDestination": { "$ref": "GoogleCloudVisionV1p4beta1GcsDestination", "description": "The Google Cloud Storage location to write the output(s) to." } } }, "GoogleCloudVisionV1p2beta1ImageProperties": { "type": "object", "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "id": "GoogleCloudVisionV1p2beta1ImageProperties", "description": "Stores image properties, such as dominant colors." }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": { "type": "object", "description": "Detected start or end of a structural component.", "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak", "properties": { "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" }, "type": { "description": "Detected break type.", "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 `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string", "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ] } } }, "GoogleCloudVisionV1p4beta1WebDetectionWebLabel": { "properties": { "languageCode": { "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "label": { "type": "string", "description": "Label for extra metadata." } }, "description": "Label to provide extra metadata for the web detection.", "id": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel", "type": "object" }, "Vertex": { "id": "Vertex", "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "type": "object", "properties": { "y": { "format": "int32", "type": "integer", "description": "Y coordinate." }, "x": { "description": "X coordinate.", "type": "integer", "format": "int32" } } }, "GoogleCloudVisionV1p2beta1ProductKeyValue": { "description": "A product label represented as a key-value pair.", "type": "object", "id": "GoogleCloudVisionV1p2beta1ProductKeyValue", "properties": { "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1ProductSearchParams": { "type": "object", "properties": { "filter": { "description": "The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, \"(color = red OR color = blue) AND brand = Google\" is acceptable, but \"(color = red OR brand = Google)\" is not acceptable. \"color: red\" is not acceptable because it uses a ':' instead of an '='.", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied." }, "productSet": { "description": "The resource name of a ProductSet to be searched for similar images. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.", "type": "string" }, "productCategories": { "description": "The list of product categories to search in. Currently, we only consider the first category, and either \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\", or \"general-v1\" should be specified. The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported but will be deprecated. For new products, please use \"homegoods-v2\", \"apparel-v2\", or \"toys-v2\" for better product search accuracy. It is recommended to migrate existing products to these categories as well.", "items": { "type": "string" }, "type": "array" } }, "description": "Parameters for a product search request.", "id": "GoogleCloudVisionV1p2beta1ProductSearchParams" }, "ImageProperties": { "description": "Stores image properties, such as dominant colors.", "id": "ImageProperties", "type": "object", "properties": { "dominantColors": { "$ref": "DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } } }, "GoogleCloudVisionV1p2beta1Word": { "type": "object", "properties": { "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected for the word." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" }, "symbols": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" }, "description": "List of symbols in the word. The order of the symbols follows the natural reading order." }, "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." } }, "id": "GoogleCloudVisionV1p2beta1Word", "description": "A word representation." }, "GoogleCloudVisionV1p2beta1ProductSearchResults": { "type": "object", "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "description": "Results for a product search request.", "properties": { "results": { "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match.", "type": "array" }, "indexTime": { "format": "google-datetime", "type": "string", "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results." }, "productGroupedResults": { "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "type": "array" } } }, "Property": { "id": "Property", "type": "object", "description": "A `Property` consists of a user-supplied name/value pair.", "properties": { "name": { "type": "string", "description": "Name of the property." }, "uint64Value": { "format": "uint64", "description": "Value of numeric properties.", "type": "string" }, "value": { "description": "Value of the property.", "type": "string" } } }, "ProductSearchResults": { "id": "ProductSearchResults", "properties": { "results": { "description": "List of results, one for each product match.", "items": { "$ref": "Result" }, "type": "array" }, "indexTime": { "format": "google-datetime", "type": "string", "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results." }, "productGroupedResults": { "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "items": { "$ref": "GroupedResult" }, "type": "array" } }, "type": "object", "description": "Results for a product search request." }, "GoogleCloudVisionV1p2beta1ColorInfo": { "properties": { "pixelFraction": { "format": "float", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "type": "number" }, "score": { "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float", "type": "number" }, "color": { "description": "RGB components of the color.", "$ref": "Color" } }, "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p2beta1ColorInfo" }, "GoogleCloudVisionV1p2beta1EntityAnnotation": { "properties": { "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "confidence": { "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "type": "number", "format": "float", "deprecated": true }, "topicality": { "type": "number", "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float" }, "properties": { "type": "array", "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" } }, "locations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocationInfo" }, "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks." }, "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "score": { "format": "float", "type": "number", "description": "Overall score of the result. Range [0, 1]." }, "mid": { "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" } }, "description": "Set of detected entity features.", "type": "object", "id": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "GoogleCloudVisionV1p1beta1Position": { "properties": { "x": { "format": "float", "description": "X coordinate.", "type": "number" }, "y": { "format": "float", "description": "Y coordinate.", "type": "number" }, "z": { "description": "Z coordinate (or depth).", "format": "float", "type": "number" } }, "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Position" }, "GoogleCloudVisionV1p3beta1BoundingPoly": { "type": "object", "properties": { "vertices": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Vertex" }, "type": "array", "description": "The bounding polygon vertices." }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1NormalizedVertex" } } }, "description": "A bounding polygon for the detected image annotation.", "id": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "GoogleCloudVisionV1p1beta1CropHint": { "type": "object", "description": "Single crop hint that is used to generate a new crop when serving an image.", "id": "GoogleCloudVisionV1p1beta1CropHint", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "importanceFraction": { "format": "float", "type": "number", "description": "Fraction of importance of this salient region with respect to the original image." }, "confidence": { "format": "float", "type": "number", "description": "Confidence of this being a salient region. Range [0, 1]." } } }, "GoogleCloudVisionV1p2beta1GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "type": "object", "id": "GoogleCloudVisionV1p2beta1GcsDestination", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1ImageContext": { "type": "object", "description": "Image context and/or feature-specific parameters.", "properties": { "latLongRect": { "$ref": "GoogleCloudVisionV1p2beta1LatLongRect", "description": "Not used." }, "textDetectionParams": { "description": "Parameters for text detection and document text detection.", "$ref": "GoogleCloudVisionV1p2beta1TextDetectionParams" }, "webDetectionParams": { "description": "Parameters for web detection.", "$ref": "GoogleCloudVisionV1p2beta1WebDetectionParams" }, "cropHintsParams": { "description": "Parameters for crop hints annotation request.", "$ref": "GoogleCloudVisionV1p2beta1CropHintsParams" }, "productSearchParams": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchParams", "description": "Parameters for product search." }, "languageHints": { "type": "array", "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).", "items": { "type": "string" } } }, "id": "GoogleCloudVisionV1p2beta1ImageContext" }, "GoogleCloudVisionV1p4beta1DominantColorsAnnotation": { "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ColorInfo" } } }, "type": "object", "id": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores." }, "CropHintsAnnotation": { "properties": { "cropHints": { "type": "array", "items": { "$ref": "CropHint" }, "description": "Crop hint results." } }, "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "id": "CropHintsAnnotation" }, "GoogleCloudVisionV1p2beta1TextAnnotation": { "properties": { "text": { "type": "string", "description": "UTF-8 text detected on the pages." }, "pages": { "items": { "$ref": "GoogleCloudVisionV1p2beta1Page" }, "type": "array", "description": "List of pages detected by OCR." } }, "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "id": "GoogleCloudVisionV1p2beta1TextAnnotation", "type": "object" }, "GoogleCloudVisionV1p4beta1BatchOperationMetadata": { "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata", "properties": { "endTime": { "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "type": "string", "format": "google-datetime" }, "submitTime": { "format": "google-datetime", "description": "The time when the batch request was submitted to the server.", "type": "string" }, "state": { "enumDescriptions": [ "Invalid.", "Request is actively being processed.", "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "type": "string", "description": "The current state of the batch operation.", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ] } }, "type": "object" }, "GoogleCloudVisionV1p2beta1LatLongRect": { "description": "Rectangle determined by min and max `LatLng` pairs.", "properties": { "maxLatLng": { "description": "Max lat/long pair.", "$ref": "LatLng" }, "minLatLng": { "description": "Min lat/long pair.", "$ref": "LatLng" } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1LatLongRect" }, "Color": { "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", "properties": { "blue": { "description": "The amount of blue in the color as a value in the interval [0, 1].", "type": "number", "format": "float" }, "red": { "type": "number", "description": "The amount of red in the color as a value in the interval [0, 1].", "format": "float" }, "alpha": { "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", "type": "number", "format": "float" }, "green": { "description": "The amount of green in the color as a value in the interval [0, 1].", "type": "number", "format": "float" } }, "type": "object" }, "ReferenceImage": { "id": "ReferenceImage", "type": "object", "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "properties": { "name": { "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" }, "boundingPolys": { "items": { "$ref": "BoundingPoly" }, "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "type": "array" } } }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest": { "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageRequest" }, "description": "Required. Individual image annotation requests for this batch." }, "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "outputConfig": { "$ref": "GoogleCloudVisionV1p2beta1OutputConfig", "description": "Required. The desired output location and metadata (e.g. format)." } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest", "description": "Request for async image annotation for a list of images." }, "GoogleCloudVisionV1p1beta1Product": { "id": "GoogleCloudVisionV1p1beta1Product", "description": "A Product contains ReferenceImages.", "properties": { "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." }, "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "productCategory": { "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { "type": "array", "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue" } } }, "type": "object" }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse": { "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p4beta1OutputConfig", "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest." } }, "type": "object", "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse", "description": "Response to an async batch image annotation request." }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { "type": "object", "properties": { "violence": { "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "adult": { "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "racy": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas." }, "medical": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this is a medical image.", "type": "string" }, "spoof": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive." } }, "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)." }, "GoogleCloudVisionV1p4beta1ProductSearchResultsResult": { "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "score": { "type": "number", "format": "float", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence)." }, "image": { "type": "string", "description": "The resource name of the image from the product that is the closest match to the query." }, "product": { "$ref": "GoogleCloudVisionV1p4beta1Product", "description": "The Product." } }, "type": "object", "description": "Information about a product." }, "DetectedLanguage": { "id": "DetectedLanguage", "properties": { "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "confidence": { "format": "float", "description": "Confidence of detected language. Range [0, 1].", "type": "number" } }, "description": "Detected language for a structural component.", "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": { "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity", "description": "Entity deduced from similar images on the Internet.", "properties": { "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "score": { "format": "float", "type": "number", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries." }, "entityId": { "description": "Opaque entity ID.", "type": "string" } }, "type": "object" }, "DetectedBreak": { "properties": { "type": { "type": "string", "description": "Detected break type.", "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 `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ] }, "isPrefix": { "type": "boolean", "description": "True if break prepends the element." } }, "description": "Detected start or end of a structural component.", "id": "DetectedBreak", "type": "object" }, "GoogleCloudVisionV1p3beta1GcsSource": { "properties": { "uri": { "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "id": "GoogleCloudVisionV1p3beta1GcsSource", "description": "The Google Cloud Storage location where the input will be read from.", "type": "object" }, "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse": { "type": "object", "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p3beta1OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } }, "id": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request." }, "GoogleCloudVisionV1p3beta1Symbol": { "properties": { "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float" }, "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." } }, "type": "object", "description": "A single symbol representation.", "id": "GoogleCloudVisionV1p3beta1Symbol" }, "GoogleCloudVisionV1p4beta1GcsDestination": { "type": "object", "properties": { "uri": { "type": "string", "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files." } }, "id": "GoogleCloudVisionV1p4beta1GcsDestination", "description": "The Google Cloud Storage location where the output will be written to." }, "GoogleCloudVisionV1p3beta1Page": { "type": "object", "id": "GoogleCloudVisionV1p3beta1Page", "properties": { "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results on the page. Range [0, 1]." }, "height": { "format": "int32", "type": "integer", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels." }, "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "width": { "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "type": "integer", "format": "int32" }, "blocks": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Block" }, "description": "List of blocks of text, images etc on this page.", "type": "array" } }, "description": "Detected page from OCR." }, "GoogleCloudVisionV1p2beta1Property": { "id": "GoogleCloudVisionV1p2beta1Property", "properties": { "value": { "description": "Value of the property.", "type": "string" }, "name": { "description": "Name of the property.", "type": "string" }, "uint64Value": { "type": "string", "format": "uint64", "description": "Value of numeric properties." } }, "type": "object", "description": "A `Property` consists of a user-supplied name/value pair." }, "GoogleCloudVisionV1p4beta1CropHintsAnnotation": { "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "id": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", "properties": { "cropHints": { "type": "array", "description": "Crop hint results.", "items": { "$ref": "GoogleCloudVisionV1p4beta1CropHint" } } } }, "GoogleCloudVisionV1p2beta1WebDetectionWebImage": { "id": "GoogleCloudVisionV1p2beta1WebDetectionWebImage", "type": "object", "description": "Metadata for online images.", "properties": { "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" }, "url": { "description": "The result image URL.", "type": "string" } } }, "WebLabel": { "properties": { "label": { "description": "Label for extra metadata.", "type": "string" }, "languageCode": { "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } }, "type": "object", "id": "WebLabel", "description": "Label to provide extra metadata for the web detection." }, "BatchAnnotateFilesResponse": { "type": "object", "id": "BatchAnnotateFilesResponse", "properties": { "responses": { "items": { "$ref": "AnnotateFileResponse" }, "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array" } }, "description": "A list of file annotation responses." }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { "properties": { "totalPages": { "type": "integer", "format": "int32", "description": "This field gives the total number of pages in the file." }, "responses": { "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, "type": "array" }, "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p2beta1InputConfig" } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses." }, "GoogleCloudVisionV1p1beta1LocationInfo": { "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "description": "Detected entity location information.", "type": "object", "id": "GoogleCloudVisionV1p1beta1LocationInfo" }, "GoogleCloudVisionV1p1beta1Property": { "properties": { "name": { "description": "Name of the property.", "type": "string" }, "uint64Value": { "format": "uint64", "type": "string", "description": "Value of numeric properties." }, "value": { "description": "Value of the property.", "type": "string" } }, "type": "object", "id": "GoogleCloudVisionV1p1beta1Property", "description": "A `Property` consists of a user-supplied name/value pair." }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest": { "description": "Multiple async file annotation requests are batched into a single service call.", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest", "type": "object", "properties": { "requests": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest" }, "type": "array", "description": "Required. Individual async file annotation requests for this batch." }, "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", "additionalProperties": { "type": "string" } } } }, "GoogleCloudVisionV1p3beta1Property": { "id": "GoogleCloudVisionV1p3beta1Property", "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "properties": { "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" }, "value": { "description": "Value of the property.", "type": "string" }, "name": { "type": "string", "description": "Name of the property." } } }, "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation": { "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation", "properties": { "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." } }, "type": "object", "description": "Prediction for what the object in the bounding box is." }, "DominantColorsAnnotation": { "id": "DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores.", "properties": { "colors": { "items": { "$ref": "ColorInfo" }, "type": "array", "description": "RGB color values with their score and pixel fraction." } }, "type": "object" }, "GoogleCloudVisionV1p3beta1EntityAnnotation": { "description": "Set of detected entity features.", "properties": { "locations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks." }, "score": { "format": "float", "description": "Overall score of the result. Range [0, 1].", "type": "number" }, "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" }, "properties": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Property" }, "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity." }, "locale": { "type": "string", "description": "The language code for the locale in which the entity textual `description` is expressed." }, "topicality": { "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float", "type": "number" }, "mid": { "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "confidence": { "deprecated": true, "type": "number", "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1EntityAnnotation", "type": "object" }, "GoogleCloudVisionV1p4beta1ReferenceImage": { "type": "object", "properties": { "uri": { "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" }, "name": { "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "boundingPolys": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not)." } }, "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes." }, "OutputConfig": { "id": "OutputConfig", "description": "The desired output location and metadata.", "properties": { "batchSize": { "format": "int32", "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "type": "integer" }, "gcsDestination": { "$ref": "GcsDestination", "description": "The Google Cloud Storage location to write the output(s) to." } }, "type": "object" }, "AsyncBatchAnnotateImagesResponse": { "properties": { "outputConfig": { "$ref": "OutputConfig", "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest." } }, "description": "Response to an async batch image annotation request.", "type": "object", "id": "AsyncBatchAnnotateImagesResponse" }, "Paragraph": { "properties": { "words": { "description": "List of all words in this paragraph.", "items": { "$ref": "Word" }, "type": "array" }, "boundingBox": { "$ref": "BoundingPoly", "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "property": { "$ref": "TextProperty", "description": "Additional information detected for the paragraph." }, "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results for the paragraph. Range [0, 1]." } }, "id": "Paragraph", "type": "object", "description": "Structural unit of text representing a number of words in certain order." }, "CropHint": { "id": "CropHint", "properties": { "confidence": { "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float" }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" }, "boundingPoly": { "$ref": "BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." } }, "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object" }, "GoogleCloudVisionV1p3beta1CropHint": { "properties": { "confidence": { "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float" }, "importanceFraction": { "type": "number", "format": "float", "description": "Fraction of importance of this salient region with respect to the original image." }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." } }, "description": "Single crop hint that is used to generate a new crop when serving an image.", "id": "GoogleCloudVisionV1p3beta1CropHint", "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotation": { "properties": { "pages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1Page" }, "type": "array", "description": "List of pages detected by OCR." }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "type": "object", "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail." }, "LatLng": { "properties": { "longitude": { "format": "double", "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "type": "number" }, "latitude": { "format": "double", "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number" } }, "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebPage": { "properties": { "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "type": "number", "format": "float" }, "url": { "description": "The result web page URL.", "type": "string" }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images on the page. Can include resized copies of the query image." }, "partialMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops." } }, "description": "Metadata for web pages.", "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage", "type": "object" }, "GoogleCloudVisionV1p1beta1Paragraph": { "type": "object", "description": "Structural unit of text representing a number of words in certain order.", "id": "GoogleCloudVisionV1p1beta1Paragraph", "properties": { "boundingBox": { "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float" }, "property": { "description": "Additional information detected for the paragraph.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "words": { "description": "List of all words in this paragraph.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Word" }, "type": "array" } } }, "GoogleCloudVisionV1p1beta1OperationMetadata": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time when the batch request was received." }, "updateTime": { "description": "The time when the operation result was last updated.", "type": "string", "format": "google-datetime" }, "state": { "description": "Current state of the batch operation.", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "type": "string", "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ] } }, "id": "GoogleCloudVisionV1p1beta1OperationMetadata", "description": "Contains metadata for the BatchAnnotateImages operation.", "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsResult": { "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "properties": { "score": { "type": "number", "format": "float", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence)." }, "image": { "type": "string", "description": "The resource name of the image from the product that is the closest match to the query." }, "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p2beta1Product" } }, "type": "object", "description": "Information about a product." }, "GoogleCloudVisionV1p2beta1TextDetectionParams": { "properties": { "enableTextDetectionConfidenceScore": { "type": "boolean", "description": "By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence score for TEXT_DETECTION as well." }, "advancedOcrOptions": { "items": { "type": "string" }, "description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.", "type": "array" } }, "type": "object", "description": "Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.", "id": "GoogleCloudVisionV1p2beta1TextDetectionParams" }, "GoogleCloudVisionV1p2beta1FaceAnnotation": { "properties": { "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Surprise likelihood.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "landmarks": { "description": "Detected face landmarks.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark" } }, "panAngle": { "format": "float", "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "type": "number" }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "detectionConfidence": { "format": "float", "description": "Detection confidence. Range [0, 1].", "type": "number" }, "blurredLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Blurred likelihood.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "boundingPoly": { "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "angerLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "sorrowLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Sorrow likelihood." }, "joyLikelihood": { "type": "string", "description": "Joy likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Headwear likelihood.", "type": "string" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "underExposedLikelihood": { "type": "string", "description": "Under-exposed likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "tiltAngle": { "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, "rollAngle": { "format": "float", "type": "number", "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]." } }, "description": "A face annotation object contains the results of face detection.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotation", "type": "object" }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "type": "object", "properties": { "racy": { "type": "string", "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "spoof": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "medical": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this is a medical image.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "violence": { "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "adult": { "type": "string", "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] } }, "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)." }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "type": "object", "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "confidence": { "description": "Confidence of detected language. Range [0, 1].", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage" }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { "type": "object", "properties": { "y": { "description": "Y coordinate.", "type": "number", "format": "float" }, "x": { "format": "float", "description": "X coordinate.", "type": "number" } }, "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudVisionV1p1beta1NormalizedVertex" }, "GoogleCloudVisionV1p3beta1ProductKeyValue": { "properties": { "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, "description": "A product label represented as a key-value pair.", "id": "GoogleCloudVisionV1p3beta1ProductKeyValue", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebImage": { "type": "object", "properties": { "score": { "format": "float", "type": "number", "description": "(Deprecated) Overall relevancy score for the image." }, "url": { "type": "string", "description": "The result image URL." } }, "id": "GoogleCloudVisionV1p3beta1WebDetectionWebImage", "description": "Metadata for online images." }, "Block": { "description": "Logical element on the page.", "type": "object", "properties": { "confidence": { "format": "float", "description": "Confidence of the OCR results on the block. Range [0, 1].", "type": "number" }, "boundingBox": { "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "BoundingPoly" }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "items": { "$ref": "Paragraph" }, "type": "array" }, "property": { "description": "Additional information detected for the block.", "$ref": "TextProperty" }, "blockType": { "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", "type": "string" } }, "id": "Block" }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { "id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse", "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "type": "object", "properties": { "referenceImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ReferenceImage" }, "description": "The list of reference_images that are imported successfully." }, "statuses": { "items": { "$ref": "Status" }, "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "type": "array" } } }, "GoogleCloudVisionV1p1beta1WebDetectionWebPage": { "type": "object", "properties": { "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float", "type": "number" }, "fullMatchingImages": { "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "type": "array" }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." }, "url": { "type": "string", "description": "The result web page URL." }, "partialMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "type": "array" } }, "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "description": "Metadata for web pages." }, "GoogleCloudVisionV1p4beta1EntityAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p4beta1EntityAnnotation", "properties": { "topicality": { "type": "number", "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float" }, "locations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocationInfo" }, "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks." }, "confidence": { "format": "float", "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "deprecated": true, "type": "number" }, "score": { "description": "Overall score of the result. Range [0, 1].", "type": "number", "format": "float" }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" }, "locale": { "type": "string", "description": "The language code for the locale in which the entity textual `description` is expressed." }, "mid": { "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "properties": { "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" }, "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "type": "array" } }, "description": "Set of detected entity features." }, "GoogleCloudVisionV1p3beta1ProductSearchResultsResult": { "properties": { "score": { "format": "float", "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence)." }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p3beta1Product" } }, "type": "object", "description": "Information about a product.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "GoogleCloudVisionV1p3beta1OutputConfig": { "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p3beta1GcsDestination" }, "batchSize": { "format": "int32", "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.", "type": "integer" } }, "description": "The desired output location and metadata.", "type": "object" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { "type": "object", "properties": { "x": { "format": "float", "type": "number", "description": "X coordinate." }, "y": { "format": "float", "description": "Y coordinate.", "type": "number" } }, "id": "GoogleCloudVisionV1p4beta1NormalizedVertex", "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1." }, "GoogleCloudVisionV1p2beta1Image": { "type": "object", "description": "Client image to perform Google Cloud Vision API tasks over.", "properties": { "source": { "description": "Google Cloud Storage image location, or publicly-accessible image URL. If both `content` and `source` are provided for an image, `content` takes precedence and is used to perform the image annotation request.", "$ref": "GoogleCloudVisionV1p2beta1ImageSource" }, "content": { "format": "byte", "type": "string", "description": "Image content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages requests." } }, "id": "GoogleCloudVisionV1p2beta1Image" }, "InputConfig": { "description": "The desired input location and metadata.", "id": "InputConfig", "properties": { "content": { "format": "byte", "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "type": "string" }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GcsSource" }, "mimeType": { "type": "string", "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported." } }, "type": "object" }, "BoundingPoly": { "id": "BoundingPoly", "properties": { "normalizedVertices": { "items": { "$ref": "NormalizedVertex" }, "type": "array", "description": "The bounding polygon normalized vertices." }, "vertices": { "type": "array", "description": "The bounding polygon vertices.", "items": { "$ref": "Vertex" } } }, "description": "A bounding polygon for the detected image annotation.", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebLabel": { "type": "object", "properties": { "label": { "type": "string", "description": "Label for extra metadata." }, "languageCode": { "type": "string", "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." } }, "description": "Label to provide extra metadata for the web detection.", "id": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" }, "GoogleCloudVisionV1p3beta1AnnotateImageResponse": { "properties": { "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext" }, "landmarkAnnotations": { "description": "If present, landmark detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "type": "array" }, "localizedObjectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "faceAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotation" }, "type": "array", "description": "If present, face detection has completed successfully." }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "productSearchResults": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResults", "description": "If present, product search has completed successfully." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "logoAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully.", "type": "array" }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p3beta1ImageProperties" }, "labelAnnotations": { "type": "array", "description": "If present, label detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" } }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1WebDetection" }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation" }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation" } }, "description": "Response to an image annotation request.", "id": "GoogleCloudVisionV1p3beta1AnnotateImageResponse", "type": "object" }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array" } }, "type": "object", "id": "Status" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." } }, "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "description": "Prediction for what the object in the bounding box is." }, "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty": { "id": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "type": "object", "description": "Additional information detected on the structural component.", "properties": { "detectedBreak": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a text segment." }, "detectedLanguages": { "type": "array", "description": "A list of detected languages together with confidence.", "items": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage" } } } }, "KeyValue": { "description": "A product label represented as a key-value pair.", "type": "object", "id": "KeyValue", "properties": { "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1GcsDestination": { "type": "object", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, "description": "The Google Cloud Storage location where the output will be written to.", "id": "GoogleCloudVisionV1p3beta1GcsDestination" }, "GoogleCloudVisionV1p2beta1Position": { "type": "object", "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Position", "properties": { "x": { "format": "float", "description": "X coordinate.", "type": "number" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "format": "float", "type": "number", "description": "Z coordinate (or depth)." } } }, "GoogleCloudVisionV1p3beta1ColorInfo": { "properties": { "color": { "$ref": "Color", "description": "RGB components of the color." }, "score": { "format": "float", "description": "Image-specific score for this color. Value in range [0, 1].", "type": "number" }, "pixelFraction": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "type": "number", "format": "float" } }, "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "type": "object", "id": "GoogleCloudVisionV1p3beta1ColorInfo" }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { "id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "statuses": { "type": "array", "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" } }, "referenceImages": { "description": "The list of reference_images that are imported successfully.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ReferenceImage" }, "type": "array" } }, "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateImageResponse": { "type": "object", "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse", "properties": { "context": { "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "logoAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "type": "array", "description": "If present, logo detection has completed successfully." }, "localizedObjectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "type": "array" }, "landmarkAnnotations": { "type": "array", "description": "If present, landmark detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" } }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation" }, "faceAnnotations": { "type": "array", "description": "If present, face detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation" } }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResults" }, "labelAnnotations": { "type": "array", "description": "If present, label detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" } }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p1beta1ImageProperties" }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1WebDetection" }, "safeSearchAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." } }, "description": "Response to an image annotation request." }, "BatchOperationMetadata": { "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "type": "object", "id": "BatchOperationMetadata", "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true." }, "state": { "description": "The current state of the batch operation.", "type": "string", "enumDescriptions": [ "Invalid.", "Request is actively being processed.", "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ] }, "submitTime": { "format": "google-datetime", "description": "The time when the batch request was submitted to the server.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest": { "type": "object", "description": "Multiple image annotation requests are batched into a single service call.", "properties": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "requests": { "description": "Required. Individual image annotation requests for this batch.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageRequest" }, "type": "array" } }, "id": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse": { "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest." } }, "description": "A list of file annotation responses.", "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse", "type": "object" }, "GoogleCloudVisionV1p4beta1Property": { "properties": { "name": { "description": "Name of the property.", "type": "string" }, "value": { "description": "Value of the property.", "type": "string" }, "uint64Value": { "format": "uint64", "type": "string", "description": "Value of numeric properties." } }, "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "id": "GoogleCloudVisionV1p4beta1Property" }, "GoogleCloudVisionV1p4beta1Symbol": { "properties": { "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "type": "number", "format": "float" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" } }, "type": "object", "description": "A single symbol representation.", "id": "GoogleCloudVisionV1p4beta1Symbol" }, "ImportProductSetsResponse": { "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "id": "ImportProductSetsResponse", "properties": { "referenceImages": { "description": "The list of reference_images that are imported successfully.", "type": "array", "items": { "$ref": "ReferenceImage" } }, "statuses": { "description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.", "items": { "$ref": "Status" }, "type": "array" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImageProperties": { "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "description": "Stores image properties, such as dominant colors.", "type": "object", "id": "GoogleCloudVisionV1p4beta1ImageProperties" }, "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation": { "id": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation", "description": "Set of detected objects with bounding boxes.", "properties": { "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "Image region to which this object belongs. This must be populated." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1InputConfig": { "id": "GoogleCloudVisionV1p4beta1InputConfig", "properties": { "content": { "type": "string", "format": "byte", "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests." }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p4beta1GcsSource" }, "mimeType": { "type": "string", "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported." } }, "type": "object", "description": "The desired input location and metadata." }, "GoogleCloudVisionV1p1beta1DominantColorsAnnotation": { "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ColorInfo" } } }, "description": "Set of dominant colors and their corresponding scores.", "type": "object", "id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation" }, "GoogleCloudVisionV1p1beta1WebDetectionWebImage": { "type": "object", "description": "Metadata for online images.", "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage", "properties": { "score": { "format": "float", "description": "(Deprecated) Overall relevancy score for the image.", "type": "number" }, "url": { "description": "The result image URL.", "type": "string" } } }, "Landmark": { "properties": { "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", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "description": "Face landmark type.", "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.", "Left cheek center.", "Right cheek center." ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "Position" } }, "id": "Landmark", "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`.", "type": "object" }, "GoogleCloudVisionV1p4beta1ProductKeyValue": { "properties": { "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "value": { "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, "type": "object", "description": "A product label represented as a key-value pair.", "id": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, "GoogleCloudVisionV1p2beta1Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "type": "object", "properties": { "x": { "type": "integer", "format": "int32", "description": "X coordinate." }, "y": { "type": "integer", "description": "Y coordinate.", "format": "int32" } }, "id": "GoogleCloudVisionV1p2beta1Vertex" }, "FaceAnnotation": { "properties": { "underExposedLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Under-exposed likelihood." }, "panAngle": { "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "joyLikelihood": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Joy likelihood." }, "detectionConfidence": { "type": "number", "format": "float", "description": "Detection confidence. Range [0, 1]." }, "surpriseLikelihood": { "type": "string", "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "rollAngle": { "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "type": "number", "format": "float" }, "angerLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "tiltAngle": { "type": "number", "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float" }, "headwearLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Headwear likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "BoundingPoly" }, "landmarks": { "description": "Detected face landmarks.", "items": { "$ref": "Landmark" }, "type": "array" }, "blurredLikelihood": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood." }, "boundingPoly": { "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.", "$ref": "BoundingPoly" }, "landmarkingConfidence": { "format": "float", "type": "number", "description": "Face landmarking confidence. Range [0, 1]." }, "sorrowLikelihood": { "type": "string", "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] } }, "type": "object", "id": "FaceAnnotation", "description": "A face annotation object contains the results of face detection." }, "TextProperty": { "type": "object", "id": "TextProperty", "properties": { "detectedLanguages": { "items": { "$ref": "DetectedLanguage" }, "description": "A list of detected languages together with confidence.", "type": "array" }, "detectedBreak": { "$ref": "DetectedBreak", "description": "Detected start or end of a text segment." } }, "description": "Additional information detected on the structural component." }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { "description": "Information about the products similar to a single product in a query image.", "type": "object", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The bounding polygon around the product detected in the query image." }, "objectAnnotations": { "type": "array", "description": "List of generic predictions for the object in the bounding box.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation" } }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." } }, "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" }, "GoogleCloudVisionV1p4beta1FaceAnnotation": { "properties": { "detectionConfidence": { "format": "float", "description": "Detection confidence. Range [0, 1].", "type": "number" }, "panAngle": { "type": "number", "format": "float", "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]." }, "underExposedLikelihood": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Under-exposed likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "surpriseLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "description": "Surprise likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." }, "recognitionResult": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "description": "Additional recognition information. Only computed if image_context.face_recognition_params is provided, **and** a match is found to a Celebrity in the input CelebritySet. This field is sorted in order of decreasing confidence values." }, "rollAngle": { "type": "number", "format": "float", "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]." }, "tiltAngle": { "type": "number", "format": "float", "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]." }, "boundingPoly": { "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "landmarks": { "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks.", "type": "array" }, "headwearLikelihood": { "description": "Headwear likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "sorrowLikelihood": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Sorrow likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "joyLikelihood": { "description": "Joy likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "landmarkingConfidence": { "format": "float", "type": "number", "description": "Face landmarking confidence. Range [0, 1]." }, "angerLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "blurredLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Blurred likelihood." } }, "id": "GoogleCloudVisionV1p4beta1FaceAnnotation", "type": "object", "description": "A face annotation object contains the results of face detection." }, "GoogleCloudVisionV1p4beta1Celebrity": { "description": "A Celebrity is a group of Faces with an identity.", "id": "GoogleCloudVisionV1p4beta1Celebrity", "type": "object", "properties": { "description": { "type": "string", "description": "The Celebrity's description." }, "displayName": { "type": "string", "description": "The Celebrity's display name." }, "name": { "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1DominantColorsAnnotation": { "type": "object", "properties": { "colors": { "items": { "$ref": "GoogleCloudVisionV1p2beta1ColorInfo" }, "description": "RGB color values with their score and pixel fraction.", "type": "array" } }, "id": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation": { "description": "Prediction for what the object in the bounding box is.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation", "properties": { "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "score": { "format": "float", "type": "number", "description": "Score of the result. Range [0, 1]." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1OperationMetadata": { "properties": { "state": { "type": "string", "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ], "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "description": "Current state of the batch operation." }, "createTime": { "description": "The time when the batch request was received.", "type": "string", "format": "google-datetime" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1OperationMetadata", "description": "Contains metadata for the BatchAnnotateImages operation." }, "GoogleCloudVisionV1p2beta1ImageSource": { "id": "GoogleCloudVisionV1p2beta1ImageSource", "properties": { "gcsImageUri": { "description": "**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", "type": "string" }, "imageUri": { "description": "The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.", "type": "string" } }, "type": "object", "description": "External image source (Google Cloud Storage or web URL image location)." }, "GoogleCloudVisionV1p2beta1Page": { "type": "object", "properties": { "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected on the page." }, "confidence": { "description": "Confidence of the OCR results on the page. Range [0, 1].", "type": "number", "format": "float" }, "height": { "type": "integer", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "width": { "type": "integer", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "blocks": { "description": "List of blocks of text, images etc on this page.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Block" } } }, "id": "GoogleCloudVisionV1p2beta1Page", "description": "Detected page from OCR." }, "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse": { "type": "object", "properties": { "responses": { "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileResponse" } } }, "description": "A list of file annotation responses.", "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "WebEntity": { "id": "WebEntity", "description": "Entity deduced from similar images on the Internet.", "type": "object", "properties": { "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "score": { "type": "number", "format": "float", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries." }, "entityId": { "type": "string", "description": "Opaque entity ID." } } }, "GoogleCloudVisionV1p3beta1CropHintsAnnotation": { "type": "object", "description": "Set of crop hints that are used to generate new crops when serving images.", "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1CropHint" }, "description": "Crop hint results." } }, "id": "GoogleCloudVisionV1p3beta1CropHintsAnnotation" }, "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": { "type": "object", "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel", "description": "Label to provide extra metadata for the web detection.", "properties": { "label": { "description": "Label for extra metadata.", "type": "string" }, "languageCode": { "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation": { "type": "object", "description": "Set of detected objects with bounding boxes.", "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "name": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" }, "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." } }, "id": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse": { "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, "description": "Individual responses to image annotation requests within the batch." } }, "id": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse", "type": "object", "description": "Response to a batch image annotation request." }, "GoogleCloudVisionV1p3beta1Block": { "properties": { "blockType": { "type": "string", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "description": "Detected block type (text, image etc) for this block.", "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ] }, "paragraphs": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Paragraph" }, "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array" }, "boundingBox": { "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "property": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "description": "Additional information detected for the block." }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1Block", "description": "Logical element on the page.", "type": "object" }, "GoogleCloudVisionV1p4beta1Paragraph": { "id": "GoogleCloudVisionV1p4beta1Paragraph", "description": "Structural unit of text representing a number of words in certain order.", "type": "object", "properties": { "boundingBox": { "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Word" } }, "property": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty", "description": "Additional information detected for the paragraph." }, "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results for the paragraph. Range [0, 1]." } } }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { "properties": { "position": { "$ref": "GoogleCloudVisionV1p4beta1Position", "description": "Face landmark position." }, "type": { "description": "Face landmark type.", "type": "string", "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", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "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.", "Left cheek center.", "Right cheek center." ] } }, "type": "object", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`." }, "WebPage": { "properties": { "url": { "type": "string", "description": "The result web page URL." }, "fullMatchingImages": { "description": "Fully matching images on the page. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "WebImage" } }, "score": { "type": "number", "format": "float", "description": "(Deprecated) Overall relevancy score for the web page." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "WebImage" }, "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops." }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" } }, "description": "Metadata for web pages.", "type": "object", "id": "WebPage" }, "GoogleCloudVisionV1p1beta1Word": { "description": "A word representation.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Word", "properties": { "confidence": { "format": "float", "type": "number", "description": "Confidence of the OCR results for the word. Range [0, 1]." }, "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected for the word." }, "symbols": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" }, "description": "List of symbols in the word. The order of the symbols follows the natural reading order." }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } } }, "GoogleCloudVisionV1p3beta1InputConfig": { "id": "GoogleCloudVisionV1p3beta1InputConfig", "properties": { "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p3beta1GcsSource" }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" }, "content": { "format": "byte", "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "type": "string" } }, "type": "object", "description": "The desired input location and metadata." }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { "description": "Information about the products similar to a single product in a query image.", "properties": { "objectAnnotations": { "type": "array", "description": "List of generic predictions for the object in the bounding box.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation" } }, "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "results": { "description": "List of results, one for each product match.", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult" }, "type": "array" } }, "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "type": "object" }, "GoogleCloudVisionV1p3beta1Paragraph": { "id": "GoogleCloudVisionV1p3beta1Paragraph", "properties": { "words": { "description": "List of all words in this paragraph.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Word" }, "type": "array" }, "property": { "description": "Additional information detected for the paragraph.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results for the paragraph. Range [0, 1]." }, "boundingBox": { "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" } }, "type": "object", "description": "Structural unit of text representing a number of words in certain order." }, "GoogleCloudVisionV1p3beta1Position": { "type": "object", "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "type": "number", "description": "Z coordinate (or depth).", "format": "float" } }, "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p3beta1Position" }, "GoogleCloudVisionV1p4beta1ColorInfo": { "type": "object", "properties": { "pixelFraction": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "type": "number", "format": "float" }, "color": { "description": "RGB components of the color.", "$ref": "Color" }, "score": { "format": "float", "type": "number", "description": "Image-specific score for this color. Value in range [0, 1]." } }, "id": "GoogleCloudVisionV1p4beta1ColorInfo", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image." }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "type": "object", "description": "Response to an async batch file annotation request.", "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse" }, "NormalizedVertex": { "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "NormalizedVertex", "type": "object", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "format": "float", "description": "Y coordinate." } } }, "GoogleCloudVisionV1p2beta1GcsSource": { "properties": { "uri": { "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "id": "GoogleCloudVisionV1p2beta1GcsSource", "type": "object", "description": "The Google Cloud Storage location where the input will be read from." }, "GoogleCloudVisionV1p2beta1WebDetectionWebPage": { "description": "Metadata for web pages.", "type": "object", "properties": { "partialMatchingImages": { "description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" } }, "url": { "type": "string", "description": "The result web page URL." }, "fullMatchingImages": { "type": "array", "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" } }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." } }, "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage" }, "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty": { "type": "object", "description": "Additional information detected on the structural component.", "properties": { "detectedBreak": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a text segment." }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage" } } }, "id": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "GoogleCloudVisionV1p1beta1ImageProperties": { "type": "object", "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "id": "GoogleCloudVisionV1p1beta1ImageProperties", "description": "Stores image properties, such as dominant colors." }, "GoogleCloudVisionV1p2beta1WebDetection": { "properties": { "bestGuessLabels": { "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "type": "array" }, "partialMatchingImages": { "type": "array", "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" } }, "visuallySimilarImages": { "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "description": "The visually similar image results.", "type": "array" }, "pagesWithMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet." }, "webEntities": { "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity" }, "description": "Deduced entities from similar images on the Internet.", "type": "array" }, "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "description": "Fully matching images from the Internet. Can include resized copies of the query image." } }, "id": "GoogleCloudVisionV1p2beta1WebDetection", "description": "Relevant information for the image from the Internet.", "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty": { "description": "Additional information detected on the structural component.", "type": "object", "id": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "properties": { "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak" }, "detectedLanguages": { "items": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence.", "type": "array" } } }, "GoogleCloudVisionV1p1beta1BoundingPoly": { "properties": { "vertices": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Vertex" }, "description": "The bounding polygon vertices.", "type": "array" }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1NormalizedVertex" } } }, "description": "A bounding polygon for the detected image annotation.", "type": "object", "id": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "GoogleCloudVisionV1p3beta1ReferenceImage": { "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "type": "object", "properties": { "name": { "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`." }, "boundingPolys": { "items": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).", "type": "array" } }, "id": "GoogleCloudVisionV1p3beta1ReferenceImage" }, "GoogleCloudVisionV1p3beta1OperationMetadata": { "description": "Contains metadata for the BatchAnnotateImages operation.", "type": "object", "id": "GoogleCloudVisionV1p3beta1OperationMetadata", "properties": { "createTime": { "type": "string", "description": "The time when the batch request was received.", "format": "google-datetime" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" }, "state": { "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ], "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "type": "string", "description": "Current state of the batch operation." } } }, "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request.", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p2beta1OutputConfig" } }, "type": "object" }, "Page": { "properties": { "blocks": { "type": "array", "description": "List of blocks of text, images etc on this page.", "items": { "$ref": "Block" } }, "property": { "$ref": "TextProperty", "description": "Additional information detected on the page." }, "width": { "format": "int32", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "type": "integer" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "height": { "type": "integer", "format": "int32", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels." } }, "description": "Detected page from OCR.", "type": "object", "id": "Page" }, "GoogleCloudVisionV1p4beta1Block": { "id": "GoogleCloudVisionV1p4beta1Block", "properties": { "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float", "type": "number" }, "paragraphs": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Paragraph" }, "description": "List of paragraphs in this block (if this blocks is of type text)." }, "blockType": { "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", "type": "string", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ] }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." } }, "description": "Logical element on the page.", "type": "object" }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { "type": "object", "properties": { "x": { "type": "number", "format": "float", "description": "X coordinate." }, "y": { "type": "number", "format": "float", "description": "Y coordinate." } }, "id": "GoogleCloudVisionV1p2beta1NormalizedVertex", "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1." }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "type": "object", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, "type": "array", "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set." }, "error": { "$ref": "Status", "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." }, "totalPages": { "format": "int32", "description": "This field gives the total number of pages in the file.", "type": "integer" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p1beta1InputConfig" } } }, "GoogleCloudVisionV1p2beta1AnnotateImageRequest": { "id": "GoogleCloudVisionV1p2beta1AnnotateImageRequest", "description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.", "properties": { "image": { "$ref": "GoogleCloudVisionV1p2beta1Image", "description": "The image to be processed." }, "imageContext": { "description": "Additional context that may accompany the image.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "features": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "description": "Requested features." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "type": "object", "properties": { "normalizedVertices": { "items": { "$ref": "GoogleCloudVisionV1p4beta1NormalizedVertex" }, "description": "The bounding polygon normalized vertices.", "type": "array" }, "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Vertex" } } }, "id": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "GoogleCloudVisionV1p2beta1WebDetectionParams": { "properties": { "includeGeoResults": { "type": "boolean", "deprecated": true, "description": "This field has no effect on results." } }, "description": "Parameters for web detection request.", "type": "object", "id": "GoogleCloudVisionV1p2beta1WebDetectionParams" }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { "type": "object", "properties": { "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" }, "responses": { "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" }, "type": "array" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p3beta1InputConfig" }, "totalPages": { "description": "This field gives the total number of pages in the file.", "format": "int32", "type": "integer" } }, "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse" }, "GoogleCloudVisionV1p4beta1WebDetectionWebEntity": { "type": "object", "description": "Entity deduced from similar images on the Internet.", "id": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity", "properties": { "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "entityId": { "description": "Opaque entity ID.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1ImageProperties": { "id": "GoogleCloudVisionV1p3beta1ImageProperties", "type": "object", "description": "Stores image properties, such as dominant colors.", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation" } } }, "GoogleCloudVisionV1p1beta1OutputConfig": { "description": "The desired output location and metadata.", "properties": { "gcsDestination": { "$ref": "GoogleCloudVisionV1p1beta1GcsDestination", "description": "The Google Cloud Storage location to write the output(s) to." }, "batchSize": { "format": "int32", "type": "integer", "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations." } }, "id": "GoogleCloudVisionV1p1beta1OutputConfig", "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation": { "properties": { "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" }, "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." } }, "description": "Prediction for what the object in the bounding box is.", "type": "object", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation" }, "GoogleCloudVisionV1p2beta1Block": { "type": "object", "properties": { "blockType": { "description": "Detected block type (text, image etc) for this block.", "type": "string", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ] }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Paragraph" } }, "boundingBox": { "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" } }, "description": "Logical element on the page.", "id": "GoogleCloudVisionV1p2beta1Block" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`.", "properties": { "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p3beta1Position" }, "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", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "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.", "Left cheek center.", "Right cheek center." ], "description": "Face landmark type.", "type": "string" } }, "type": "object", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark" }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak": { "id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a structural component.", "properties": { "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" }, "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 `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak": { "properties": { "isPrefix": { "type": "boolean", "description": "True if break prepends the element." }, "type": { "description": "Detected break type.", "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ], "type": "string", "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 `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ] } }, "description": "Detected start or end of a structural component.", "type": "object", "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak" }, "GoogleCloudVisionV1p4beta1Vertex": { "id": "GoogleCloudVisionV1p4beta1Vertex", "type": "object", "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "properties": { "y": { "format": "int32", "description": "Y coordinate.", "type": "integer" }, "x": { "type": "integer", "description": "X coordinate.", "format": "int32" } } }, "GoogleCloudVisionV1p2beta1CropHintsAnnotation": { "properties": { "cropHints": { "items": { "$ref": "GoogleCloudVisionV1p2beta1CropHint" }, "type": "array", "description": "Crop hint results." } }, "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "id": "GoogleCloudVisionV1p2beta1CropHintsAnnotation" }, "GoogleCloudVisionV1p2beta1InputConfig": { "properties": { "gcsSource": { "$ref": "GoogleCloudVisionV1p2beta1GcsSource", "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" }, "content": { "format": "byte", "type": "string", "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests." } }, "description": "The desired input location and metadata.", "id": "GoogleCloudVisionV1p2beta1InputConfig", "type": "object" }, "GoogleCloudVisionV1p3beta1LocationInfo": { "type": "object", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } }, "id": "GoogleCloudVisionV1p3beta1LocationInfo", "description": "Detected entity location information." }, "GoogleCloudVisionV1p4beta1GcsSource": { "properties": { "uri": { "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "id": "GoogleCloudVisionV1p4beta1GcsSource", "description": "The Google Cloud Storage location where the input will be read from.", "type": "object" }, "AnnotateImageResponse": { "type": "object", "properties": { "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "localizedObjectAnnotations": { "type": "array", "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "LocalizedObjectAnnotation" } }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "ImageProperties" }, "safeSearchAnnotation": { "$ref": "SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." }, "context": { "$ref": "ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "TextAnnotation" }, "labelAnnotations": { "type": "array", "description": "If present, label detection has completed successfully.", "items": { "$ref": "EntityAnnotation" } }, "faceAnnotations": { "items": { "$ref": "FaceAnnotation" }, "type": "array", "description": "If present, face detection has completed successfully." }, "cropHintsAnnotation": { "$ref": "CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "textAnnotations": { "type": "array", "description": "If present, text (OCR) detection has completed successfully.", "items": { "$ref": "EntityAnnotation" } }, "webDetection": { "$ref": "WebDetection", "description": "If present, web detection has completed successfully." }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "ProductSearchResults" }, "landmarkAnnotations": { "items": { "$ref": "EntityAnnotation" }, "description": "If present, landmark detection has completed successfully.", "type": "array" }, "logoAnnotations": { "items": { "$ref": "EntityAnnotation" }, "description": "If present, logo detection has completed successfully.", "type": "array" } }, "id": "AnnotateImageResponse", "description": "Response to an image annotation request." }, "TextAnnotation": { "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "type": "object", "id": "TextAnnotation", "properties": { "pages": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "Page" } }, "text": { "description": "UTF-8 text detected on the pages.", "type": "string" } } }, "GoogleCloudVisionV1p1beta1Page": { "type": "object", "properties": { "blocks": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Block" }, "description": "List of blocks of text, images etc on this page.", "type": "array" }, "confidence": { "format": "float", "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1]." }, "height": { "type": "integer", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "width": { "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected on the page." } }, "description": "Detected page from OCR.", "id": "GoogleCloudVisionV1p1beta1Page" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { "properties": { "results": { "description": "List of results, one for each product match.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" }, "type": "array" }, "objectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation" }, "description": "List of generic predictions for the object in the bounding box.", "type": "array" }, "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } }, "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage": { "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "confidence": { "description": "Confidence of detected language. Range [0, 1].", "type": "number", "format": "float" } }, "id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage", "type": "object", "description": "Detected language for a structural component." }, "GoogleCloudVisionV1p3beta1Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "type": "object", "properties": { "x": { "description": "X coordinate.", "format": "int32", "type": "integer" }, "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudVisionV1p3beta1Vertex" }, "GoogleCloudVisionV1p1beta1WebDetection": { "description": "Relevant information for the image from the Internet.", "properties": { "webEntities": { "description": "Deduced entities from similar images on the Internet.", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity" }, "type": "array" }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" } }, "partialMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "type": "array" }, "visuallySimilarImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "The visually similar image results." }, "bestGuessLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web." }, "pagesWithMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet.", "type": "array" } }, "id": "GoogleCloudVisionV1p1beta1WebDetection", "type": "object" }, "Product": { "description": "A Product contains ReferenceImages.", "type": "object", "properties": { "productLabels": { "items": { "$ref": "KeyValue" }, "type": "array", "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." }, "productCategory": { "type": "string", "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products." }, "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "name": { "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "description": { "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" } }, "id": "Product" }, "GoogleCloudVisionV1p1beta1CropHintsAnnotation": { "properties": { "cropHints": { "type": "array", "description": "Crop hint results.", "items": { "$ref": "GoogleCloudVisionV1p1beta1CropHint" } } }, "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation" }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage", "properties": { "languageCode": { "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" }, "confidence": { "description": "Confidence of detected language. Range [0, 1].", "type": "number", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1Word": { "properties": { "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "symbols": { "type": "array", "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" } }, "confidence": { "type": "number", "format": "float", "description": "Confidence of the OCR results for the word. Range [0, 1]." }, "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" } }, "id": "GoogleCloudVisionV1p3beta1Word", "type": "object", "description": "A word representation." }, "GoogleCloudVisionV1p4beta1Page": { "properties": { "width": { "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "type": "integer", "format": "int32" }, "blocks": { "items": { "$ref": "GoogleCloudVisionV1p4beta1Block" }, "description": "List of blocks of text, images etc on this page.", "type": "array" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "height": { "type": "integer", "format": "int32", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels." }, "property": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty", "description": "Additional information detected on the page." } }, "id": "GoogleCloudVisionV1p4beta1Page", "description": "Detected page from OCR.", "type": "object" }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "description": "Response to an async batch file annotation request.", "type": "object", "properties": { "responses": { "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" }, "type": "array" } } }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse", "type": "object", "description": "Response to an async batch file annotation request." }, "GoogleCloudVisionV1p1beta1InputConfig": { "id": "GoogleCloudVisionV1p1beta1InputConfig", "description": "The desired input location and metadata.", "type": "object", "properties": { "content": { "description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.", "format": "byte", "type": "string" }, "gcsSource": { "$ref": "GoogleCloudVisionV1p1beta1GcsSource", "description": "The Google Cloud Storage location to read the input from." }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } } }, "ObjectAnnotation": { "description": "Prediction for what the object in the bounding box is.", "type": "object", "id": "ObjectAnnotation", "properties": { "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "name": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p4beta1Position": { "properties": { "x": { "type": "number", "format": "float", "description": "X coordinate." }, "y": { "description": "Y coordinate.", "type": "number", "format": "float" }, "z": { "type": "number", "format": "float", "description": "Z coordinate (or depth)." } }, "id": "GoogleCloudVisionV1p4beta1Position", "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "type": "object" }, "LocationInfo": { "description": "Detected entity location information.", "id": "LocationInfo", "type": "object", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } } }, "GoogleCloudVisionV1p2beta1Paragraph": { "properties": { "boundingBox": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)." }, "words": { "items": { "$ref": "GoogleCloudVisionV1p2beta1Word" }, "type": "array", "description": "List of all words in this paragraph." }, "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected for the paragraph." }, "confidence": { "format": "float", "type": "number", "description": "Confidence of the OCR results for the paragraph. Range [0, 1]." } }, "description": "Structural unit of text representing a number of words in certain order.", "type": "object", "id": "GoogleCloudVisionV1p2beta1Paragraph" }, "GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "type": "object", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, "id": "GcsDestination" }, "GoogleCloudVisionV1p4beta1AnnotateImageResponse": { "id": "GoogleCloudVisionV1p4beta1AnnotateImageResponse", "description": "Response to an image annotation request.", "properties": { "webDetection": { "$ref": "GoogleCloudVisionV1p4beta1WebDetection", "description": "If present, web detection has completed successfully." }, "localizedObjectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "type": "array" }, "context": { "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p4beta1ImageProperties" }, "labelAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation" }, "landmarkAnnotations": { "description": "If present, landmark detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" } }, "safeSearchAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." }, "faceAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotation" }, "type": "array", "description": "If present, face detection has completed successfully." }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotation", "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text." }, "productSearchResults": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResults", "description": "If present, product search has completed successfully." }, "logoAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { "id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "properties": { "submitTime": { "description": "The time when the batch request was submitted to the server.", "format": "google-datetime", "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "Invalid.", "Request is actively being processed.", "The request is done and at least one item has been successfully processed.", "The request is done and no item has been successfully processed.", "The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request." ], "description": "The current state of the batch operation.", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ] }, "endTime": { "format": "google-datetime", "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "type": "string" } }, "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "type": "object" }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "properties": { "pageNumber": { "type": "integer", "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32" }, "uri": { "type": "string", "description": "The URI of the file used to produce the image." } }, "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`.", "properties": { "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", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "description": "Face landmark type.", "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.", "Left cheek center.", "Right cheek center." ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p2beta1Position" } }, "type": "object", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark" }, "GoogleCloudVisionV1p1beta1ColorInfo": { "id": "GoogleCloudVisionV1p1beta1ColorInfo", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "type": "object", "properties": { "score": { "format": "float", "type": "number", "description": "Image-specific score for this color. Value in range [0, 1]." }, "color": { "description": "RGB components of the color.", "$ref": "Color" }, "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" } } }, "ColorInfo": { "properties": { "score": { "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float", "type": "number" }, "color": { "$ref": "Color", "description": "RGB components of the color." }, "pixelFraction": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "type": "number", "format": "float" } }, "type": "object", "id": "ColorInfo", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image." }, "WebDetection": { "id": "WebDetection", "properties": { "fullMatchingImages": { "type": "array", "items": { "$ref": "WebImage" }, "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "bestGuessLabels": { "type": "array", "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "WebLabel" } }, "partialMatchingImages": { "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "WebImage" }, "type": "array" }, "visuallySimilarImages": { "description": "The visually similar image results.", "type": "array", "items": { "$ref": "WebImage" } }, "pagesWithMatchingImages": { "type": "array", "description": "Web pages containing the matching images from the Internet.", "items": { "$ref": "WebPage" } }, "webEntities": { "type": "array", "description": "Deduced entities from similar images on the Internet.", "items": { "$ref": "WebEntity" } } }, "type": "object", "description": "Relevant information for the image from the Internet." }, "GoogleCloudVisionV1p4beta1OperationMetadata": { "id": "GoogleCloudVisionV1p4beta1OperationMetadata", "type": "object", "description": "Contains metadata for the BatchAnnotateImages operation.", "properties": { "createTime": { "type": "string", "format": "google-datetime", "description": "The time when the batch request was received." }, "updateTime": { "format": "google-datetime", "type": "string", "description": "The time when the operation result was last updated." }, "state": { "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ], "type": "string", "description": "Current state of the batch operation.", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ] } } }, "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse", "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p1beta1OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } }, "type": "object", "description": "The response for a single offline file annotation request." }, "AsyncAnnotateFileResponse": { "type": "object", "properties": { "outputConfig": { "$ref": "OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } }, "description": "The response for a single offline file annotation request.", "id": "AsyncAnnotateFileResponse" }, "Symbol": { "description": "A single symbol representation.", "type": "object", "id": "Symbol", "properties": { "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "BoundingPoly" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "TextProperty" } } }, "GoogleCloudVisionV1p4beta1Word": { "properties": { "symbols": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" }, "description": "List of symbols in the word. The order of the symbols follows the natural reading order." }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float" }, "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" } }, "type": "object", "id": "GoogleCloudVisionV1p4beta1Word", "description": "A word representation." }, "GoogleCloudVisionV1p1beta1Vertex": { "type": "object", "id": "GoogleCloudVisionV1p1beta1Vertex", "properties": { "x": { "format": "int32", "type": "integer", "description": "X coordinate." }, "y": { "type": "integer", "format": "int32", "description": "Y coordinate." } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest": { "id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest", "type": "object", "description": "An offline file annotation request.", "properties": { "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "features": { "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "type": "array", "description": "Required. Requested features." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Required. Information about the input file." }, "outputConfig": { "$ref": "GoogleCloudVisionV1p2beta1OutputConfig", "description": "Required. The desired output location and metadata (e.g. format)." } } }, "GoogleCloudVisionV1p4beta1WebDetection": { "description": "Relevant information for the image from the Internet.", "properties": { "webEntities": { "description": "Deduced entities from similar images on the Internet.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity" }, "type": "array" }, "bestGuessLabels": { "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" } }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "type": "array" }, "pagesWithMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebPage" }, "type": "array", "description": "Web pages containing the matching images from the Internet." }, "partialMatchingImages": { "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "type": "array" }, "visuallySimilarImages": { "type": "array", "description": "The visually similar image results.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" } } }, "id": "GoogleCloudVisionV1p4beta1WebDetection", "type": "object" }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { "type": "object", "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateImageResponse" }, "type": "array", "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set." }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p4beta1InputConfig" }, "totalPages": { "description": "This field gives the total number of pages in the file.", "format": "int32", "type": "integer" }, "error": { "$ref": "Status", "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." } } }, "SafeSearchAnnotation": { "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "properties": { "racy": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "type": "string" }, "violence": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "type": "string" }, "spoof": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "medical": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Likelihood that this is a medical image.", "type": "string" }, "adult": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities." } }, "id": "SafeSearchAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResults": { "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "properties": { "results": { "type": "array", "description": "List of results, one for each product match.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" } }, "productGroupedResults": { "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" } }, "indexTime": { "format": "google-datetime", "description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.", "type": "string" } }, "type": "object", "description": "Results for a product search request." }, "Word": { "type": "object", "id": "Word", "properties": { "symbols": { "type": "array", "items": { "$ref": "Symbol" }, "description": "List of symbols in the word. The order of the symbols follows the natural reading order." }, "confidence": { "format": "float", "description": "Confidence of the OCR results for the word. Range [0, 1].", "type": "number" }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "BoundingPoly" }, "property": { "description": "Additional information detected for the word.", "$ref": "TextProperty" } }, "description": "A word representation." }, "GoogleCloudVisionV1p1beta1TextAnnotation": { "id": "GoogleCloudVisionV1p1beta1TextAnnotation", "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "type": "object", "properties": { "pages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Page" }, "type": "array", "description": "List of pages detected by OCR." }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } } }, "GoogleCloudVisionV1p1beta1GcsSource": { "properties": { "uri": { "type": "string", "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported." } }, "description": "The Google Cloud Storage location where the input will be read from.", "id": "GoogleCloudVisionV1p1beta1GcsSource", "type": "object" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsResult": { "type": "object", "properties": { "score": { "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p1beta1Product" } }, "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult", "description": "Information about a product." }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage", "properties": { "confidence": { "description": "Confidence of detected language. Range [0, 1].", "type": "number", "format": "float" }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." } }, "type": "object" }, "Position": { "properties": { "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "format": "float", "type": "number", "description": "Z coordinate (or depth)." }, "x": { "description": "X coordinate.", "type": "number", "format": "float" } }, "id": "Position", "type": "object", "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation": { "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" }, "score": { "type": "number", "format": "float", "description": "Score of the result. Range [0, 1]." }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." } }, "id": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation", "type": "object", "description": "Set of detected objects with bounding boxes." }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { "type": "object", "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "properties": { "adult": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "racy": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas." }, "violence": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "spoof": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "type": "string" }, "medical": { "description": "Likelihood that this is a medical image.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] } }, "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { "type": "object", "properties": { "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p1beta1Position" }, "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", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "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.", "Left cheek center.", "Right cheek center." ], "type": "string", "description": "Face landmark type." } }, "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`." }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", "properties": { "uri": { "description": "The URI of the file used to produce the image.", "type": "string" }, "pageNumber": { "type": "integer", "format": "int32", "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image." } }, "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "type": "object" }, "GoogleCloudVisionV1p2beta1WebDetectionWebLabel": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "label": { "description": "Label for extra metadata.", "type": "string" } }, "description": "Label to provide extra metadata for the web detection.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "GoogleCloudVisionV1p2beta1WebDetectionWebEntity": { "description": "Entity deduced from similar images on the Internet.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity", "type": "object", "properties": { "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "entityId": { "description": "Opaque entity ID.", "type": "string" }, "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "type": "number", "format": "float" } } }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak": { "description": "Detected start or end of a structural component.", "type": "object", "properties": { "type": { "type": "string", "description": "Detected break type.", "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 `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ] }, "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" } }, "id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak" }, "ImageAnnotationContext": { "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "properties": { "uri": { "description": "The URI of the file used to produce the image.", "type": "string" }, "pageNumber": { "type": "integer", "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32" } }, "type": "object", "id": "ImageAnnotationContext" }, "GoogleCloudVisionV1p3beta1DominantColorsAnnotation": { "type": "object", "description": "Set of dominant colors and their corresponding scores.", "id": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation", "properties": { "colors": { "items": { "$ref": "GoogleCloudVisionV1p3beta1ColorInfo" }, "type": "array", "description": "RGB color values with their score and pixel fraction." } } }, "GcsSource": { "description": "The Google Cloud Storage location where the input will be read from.", "id": "GcsSource", "type": "object", "properties": { "uri": { "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1FaceAnnotation": { "id": "GoogleCloudVisionV1p3beta1FaceAnnotation", "properties": { "panAngle": { "format": "float", "type": "number", "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]." }, "landmarks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks." }, "landmarkingConfidence": { "type": "number", "description": "Face landmarking confidence. Range [0, 1].", "format": "float" }, "detectionConfidence": { "type": "number", "format": "float", "description": "Detection confidence. Range [0, 1]." }, "headwearLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Headwear likelihood.", "type": "string" }, "underExposedLikelihood": { "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Under-exposed likelihood." }, "blurredLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated." }, "angerLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "type": "string" }, "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Surprise likelihood.", "type": "string" }, "rollAngle": { "format": "float", "type": "number", "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]." }, "tiltAngle": { "type": "number", "format": "float", "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180]." }, "joyLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "description": "Joy likelihood." }, "sorrowLikelihood": { "description": "Sorrow likelihood.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix." } }, "description": "A face annotation object contains the results of face detection.", "type": "object" }, "GoogleCloudVisionV1p4beta1Product": { "properties": { "productCategory": { "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.", "type": "string" }, "productLabels": { "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, "type": "array", "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." }, "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." }, "name": { "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.", "type": "string" }, "displayName": { "type": "string", "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long." } }, "type": "object", "description": "A Product contains ReferenceImages.", "id": "GoogleCloudVisionV1p4beta1Product" }, "GoogleCloudVisionV1p2beta1CropHintsParams": { "properties": { "aspectRatios": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored." } }, "id": "GoogleCloudVisionV1p2beta1CropHintsParams", "description": "Parameters for crop hints annotation request.", "type": "object" }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { "type": "object", "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "properties": { "violence": { "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "spoof": { "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "racy": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string", "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas." }, "medical": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this is a medical image.", "type": "string" }, "adult": { "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" } }, "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation" } }, "resources": { "files": { "methods": { "asyncBatchAnnotate": { "parameterOrder": [], "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "parameters": {}, "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "response": { "$ref": "Operation" }, "flatPath": "v1p2beta1/files:asyncBatchAnnotate", "httpMethod": "POST", "path": "v1p2beta1/files:asyncBatchAnnotate", "id": "vision.files.asyncBatchAnnotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] }, "annotate": { "httpMethod": "POST", "flatPath": "v1p2beta1/files:annotate", "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "id": "vision.files.annotate", "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "parameterOrder": [], "path": "v1p2beta1/files:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameters": {}, "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" } } } }, "images": { "methods": { "asyncBatchAnnotate": { "path": "v1p2beta1/images:asyncBatchAnnotate", "flatPath": "v1p2beta1/images:asyncBatchAnnotate", "parameters": {}, "response": { "$ref": "Operation" }, "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "id": "vision.images.asyncBatchAnnotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameterOrder": [], "httpMethod": "POST", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" } }, "annotate": { "flatPath": "v1p2beta1/images:annotate", "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" }, "parameters": {}, "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "id": "vision.images.annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameterOrder": [], "description": "Run image detection and annotation for a batch of images.", "path": "v1p2beta1/images:annotate", "httpMethod": "POST" } } }, "projects": { "resources": { "images": { "methods": { "asyncBatchAnnotate": { "id": "vision.projects.images.asyncBatchAnnotate", "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "response": { "$ref": "Operation" }, "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "flatPath": "v1p2beta1/projects/{projectsId}/images:asyncBatchAnnotate", "path": "v1p2beta1/{+parent}/images:asyncBatchAnnotate", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "type": "string", "location": "path", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "required": true } } }, "annotate": { "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true } }, "path": "v1p2beta1/{+parent}/images:annotate", "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" }, "flatPath": "v1p2beta1/projects/{projectsId}/images:annotate", "httpMethod": "POST", "id": "vision.projects.images.annotate", "description": "Run image detection and annotation for a batch of images." } } }, "files": { "methods": { "asyncBatchAnnotate": { "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1p2beta1/{+parent}/files:asyncBatchAnnotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "response": { "$ref": "Operation" }, "flatPath": "v1p2beta1/projects/{projectsId}/files:asyncBatchAnnotate", "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "pattern": "^projects/[^/]+$", "type": "string", "location": "path", "required": true } }, "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "id": "vision.projects.files.asyncBatchAnnotate" }, "annotate": { "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "pattern": "^projects/[^/]+$", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "flatPath": "v1p2beta1/projects/{projectsId}/files:annotate", "path": "v1p2beta1/{+parent}/files:annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "id": "vision.projects.files.annotate", "httpMethod": "POST" } } }, "locations": { "resources": { "images": { "methods": { "annotate": { "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" }, "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/images:annotate", "id": "vision.projects.locations.images.annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p2beta1/{+parent}/images:annotate", "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "Run image detection and annotation for a batch of images." }, "asyncBatchAnnotate": { "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "path": "v1p2beta1/{+parent}/images:asyncBatchAnnotate", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate", "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "id": "vision.projects.locations.images.asyncBatchAnnotate", "httpMethod": "POST", "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto." } } }, "files": { "methods": { "asyncBatchAnnotate": { "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1p2beta1/{+parent}/files:asyncBatchAnnotate", "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "id": "vision.projects.locations.files.asyncBatchAnnotate" }, "annotate": { "path": "v1p2beta1/{+parent}/files:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "id": "vision.projects.locations.files.annotate", "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:annotate", "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } } } } } } } } } }, "version_module": true, "servicePath": "", "title": "Cloud Vision API", "documentationLink": "https://cloud.google.com/vision/", "basePath": "", "discoveryVersion": "v1", "kind": "discovery#restDescription", "id": "vision:v1p2beta1", "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "fullyEncodeReservedExpansion": true, "revision": "20260925", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-vision": { "description": "Apply machine learning models to understand and label images" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Vision", "mtlsRootUrl": "https://vision.mtls.googleapis.com/", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { "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": { "type": "string", "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" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "prettyPrint": { "type": "boolean", "default": "true", "description": "Returns response with indentations and line breaks.", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "alt": { "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "type": "string", "default": "json" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" } }, "name": "vision" }