{ "name": "vision", "protocol": "rest", "version": "v1p2beta1", "mtlsRootUrl": "https://vision.mtls.googleapis.com/", "canonicalName": "Vision", "fullyEncodeReservedExpansion": true, "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.", "schemas": { "GoogleCloudVisionV1p1beta1WebDetectionWebPage": { "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "description": "Metadata for web pages.", "type": "object", "properties": { "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images on the page. Can include resized copies of the query image." }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "url": { "description": "The result web page URL.", "type": "string" }, "partialMatchingImages": { "type": "array", "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." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" } } }, "DetectedLanguage": { "type": "object", "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].", "format": "float", "type": "number" } }, "id": "DetectedLanguage", "description": "Detected language for a structural component." }, "AsyncAnnotateFileResponse": { "description": "The response for a single offline file annotation request.", "id": "AsyncAnnotateFileResponse", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "OutputConfig" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { "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": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ], "type": "string", "description": "The current state of the batch operation.", "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." ] }, "submitTime": { "description": "The time when the batch request was submitted to the server.", "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime" } }, "type": "object" }, "AnnotateImageResponse": { "properties": { "landmarkAnnotations": { "description": "If present, landmark detection has completed successfully.", "items": { "$ref": "EntityAnnotation" }, "type": "array" }, "cropHintsAnnotation": { "$ref": "CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "fullTextAnnotation": { "$ref": "TextAnnotation", "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." }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "WebDetection" }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "ImageAnnotationContext" }, "localizedObjectAnnotations": { "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "type": "array", "items": { "$ref": "LocalizedObjectAnnotation" } }, "productSearchResults": { "$ref": "ProductSearchResults", "description": "If present, product search has completed successfully." }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "items": { "$ref": "EntityAnnotation" }, "type": "array" }, "faceAnnotations": { "type": "array", "items": { "$ref": "FaceAnnotation" }, "description": "If present, face detection has completed successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "items": { "$ref": "EntityAnnotation" }, "type": "array" }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", "items": { "$ref": "EntityAnnotation" }, "type": "array" }, "safeSearchAnnotation": { "$ref": "SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." }, "imagePropertiesAnnotation": { "$ref": "ImageProperties", "description": "If present, image properties were extracted successfully." }, "error": { "$ref": "Status", "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." } }, "type": "object", "description": "Response to an image annotation request.", "id": "AnnotateImageResponse" }, "GoogleCloudVisionV1p1beta1Word": { "description": "A word representation.", "id": "GoogleCloudVisionV1p1beta1Word", "properties": { "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected for the word." }, "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" }, "symbols": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" }, "type": "array", "description": "List of symbols in the word. The order of the symbols follows the natural reading order." }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1Page": { "type": "object", "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "height": { "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, "width": { "type": "integer", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "blocks": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Block" }, "type": "array", "description": "List of blocks of text, images etc on this page." } }, "id": "GoogleCloudVisionV1p3beta1Page", "description": "Detected page from OCR." }, "GoogleCloudVisionV1p1beta1Symbol": { "id": "GoogleCloudVisionV1p1beta1Symbol", "description": "A single symbol representation.", "type": "object", "properties": { "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" }, "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected for the symbol." }, "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" } } }, "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": { "state": { "description": "The current state of the batch operation.", "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" ], "type": "string" }, "submitTime": { "type": "string", "description": "The time when the batch request was submitted to the server.", "format": "google-datetime" }, "endTime": { "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "DetectedBreak": { "description": "Detected start or end of a structural component.", "id": "DetectedBreak", "properties": { "type": { "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ], "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." ] }, "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1GcsSource": { "description": "The Google Cloud Storage location where the input will be read from.", "id": "GoogleCloudVisionV1p1beta1GcsSource", "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" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "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", "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": { "description": "The URI of the file used to produce the image.", "type": "string" } } }, "LocalizedObjectAnnotation": { "description": "Set of detected objects with bounding boxes.", "id": "LocalizedObjectAnnotation", "properties": { "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "BoundingPoly" }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "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" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1InputConfig": { "id": "GoogleCloudVisionV1p1beta1InputConfig", "description": "The desired input location and metadata.", "type": "object", "properties": { "content": { "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.", "format": "byte" }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p1beta1GcsSource" }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" } } }, "GoogleCloudVisionV1p1beta1Page": { "id": "GoogleCloudVisionV1p1beta1Page", "description": "Detected page from OCR.", "type": "object", "properties": { "confidence": { "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "blocks": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Block" }, "type": "array", "description": "List of blocks of text, images etc on this page." }, "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" } } }, "GoogleCloudVisionV1p1beta1EntityAnnotation": { "type": "object", "properties": { "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "score": { "type": "number", "description": "Overall score of the result. Range [0, 1].", "format": "float" }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "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].", "format": "float", "deprecated": true, "type": "number" }, "properties": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" }, "type": "array", "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" }, "locations": { "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocationInfo" } } }, "id": "GoogleCloudVisionV1p1beta1EntityAnnotation", "description": "Set of detected entity features." }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse", "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": { "inputConfig": { "$ref": "GoogleCloudVisionV1p4beta1InputConfig", "description": "Information about the file for which this response is generated." }, "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": { "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." }, "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" } } }, "ImageAnnotationContext": { "id": "ImageAnnotationContext", "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", "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" } } }, "ColorInfo": { "properties": { "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" }, "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." } }, "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "ColorInfo" }, "GoogleCloudVisionV1p1beta1GcsDestination": { "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": "GoogleCloudVisionV1p1beta1GcsDestination", "description": "The Google Cloud Storage location where the output will be written to." }, "Position": { "id": "Position", "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", "properties": { "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "description": "Z coordinate (or depth).", "format": "float", "type": "number" }, "x": { "type": "number", "description": "X coordinate.", "format": "float" } } }, "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.", "id": "GoogleCloudVisionV1p1beta1TextAnnotation", "properties": { "pages": { "description": "List of pages detected by OCR.", "items": { "$ref": "GoogleCloudVisionV1p1beta1Page" }, "type": "array" }, "text": { "description": "UTF-8 text detected on the pages.", "type": "string" } }, "type": "object" }, "Status": { "id": "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).", "type": "object", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "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" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" } } }, "GoogleCloudVisionV1p3beta1Position": { "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", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "description": "Z coordinate (or depth).", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1Word": { "properties": { "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": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "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)." }, "symbols": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" }, "description": "List of symbols in the word. The order of the symbols follows the natural reading order." } }, "type": "object", "description": "A word representation.", "id": "GoogleCloudVisionV1p4beta1Word" }, "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse", "description": "Response to an async batch file annotation request.", "type": "object", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } } }, "GoogleCloudVisionV1p3beta1WebDetectionWebPage": { "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage", "description": "Metadata for web pages.", "type": "object", "properties": { "url": { "type": "string", "description": "The result web page URL." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "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." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images on the page. Can include resized copies of the query image." }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" } } }, "GoogleCloudVisionV1p4beta1ImageProperties": { "type": "object", "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "id": "GoogleCloudVisionV1p4beta1ImageProperties", "description": "Stores image properties, such as dominant colors." }, "GoogleCloudVisionV1p2beta1Property": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the property." }, "value": { "type": "string", "description": "Value of the property." }, "uint64Value": { "description": "Value of numeric properties.", "format": "uint64", "type": "string" } }, "id": "GoogleCloudVisionV1p2beta1Property", "description": "A `Property` consists of a user-supplied name/value pair." }, "GoogleCloudVisionV1p2beta1ProductKeyValue": { "description": "A product label represented as a key-value pair.", "id": "GoogleCloudVisionV1p2beta1ProductKeyValue", "properties": { "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak": { "id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a structural component.", "type": "object", "properties": { "isPrefix": { "type": "boolean", "description": "True if break prepends the element." }, "type": { "type": "string", "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." ], "description": "Detected break type." } } }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { "type": "object", "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" } }, "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext", "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image." }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse": { "description": "Response to an async batch image annotation request.", "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest.", "$ref": "GoogleCloudVisionV1p4beta1OutputConfig" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1Word": { "description": "A word representation.", "id": "GoogleCloudVisionV1p2beta1Word", "properties": { "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "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": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" }, "type": "array" }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ReferenceImage": { "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "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": { "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)." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse": { "properties": { "responses": { "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" } } }, "type": "object", "description": "A list of file annotation responses.", "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse" }, "OperationMetadata": { "properties": { "state": { "description": "Current state of the batch operation.", "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" }, "createTime": { "description": "The time when the batch request was received.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Contains metadata for the BatchAnnotateImages operation.", "id": "OperationMetadata" }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak": { "type": "object", "properties": { "isPrefix": { "type": "boolean", "description": "True if break prepends the element." }, "type": { "type": "string", "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." ], "description": "Detected break type." } }, "id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a structural component." }, "GoogleCloudVisionV1p4beta1ProductKeyValue": { "id": "GoogleCloudVisionV1p4beta1ProductKeyValue", "description": "A product label represented as a key-value pair.", "type": "object", "properties": { "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." } } }, "GoogleCloudVisionV1p2beta1CropHintsParams": { "id": "GoogleCloudVisionV1p2beta1CropHintsParams", "description": "Parameters for crop hints annotation request.", "type": "object", "properties": { "aspectRatios": { "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.", "items": { "format": "float", "type": "number" }, "type": "array" } } }, "GoogleCloudVisionV1p1beta1WebDetection": { "type": "object", "properties": { "webEntities": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity" }, "type": "array", "description": "Deduced entities from similar images on the Internet." }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" } }, "pagesWithMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" } }, "visuallySimilarImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "The visually similar image results." }, "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": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" } } }, "id": "GoogleCloudVisionV1p1beta1WebDetection", "description": "Relevant information for the image from the Internet." }, "GoogleCloudVisionV1p3beta1CropHintsAnnotation": { "type": "object", "properties": { "cropHints": { "items": { "$ref": "GoogleCloudVisionV1p3beta1CropHint" }, "type": "array", "description": "Crop hint results." } }, "id": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", "description": "Set of crop hints that are used to generate new crops when serving images." }, "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" } }, "id": "GoogleCloudVisionV1p3beta1GcsDestination", "description": "The Google Cloud Storage location where the output will be written to." }, "GoogleCloudVisionV1p2beta1Position": { "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "description": "Y coordinate.", "format": "float", "type": "number" }, "z": { "type": "number", "description": "Z coordinate (or depth).", "format": "float" } }, "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" }, "WebPage": { "type": "object", "properties": { "fullMatchingImages": { "type": "array", "items": { "$ref": "WebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image." }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "url": { "type": "string", "description": "The result web page URL." }, "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": "WebImage" } }, "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float", "type": "number" } }, "id": "WebPage", "description": "Metadata for web pages." }, "GoogleCloudVisionV1p4beta1Symbol": { "description": "A single symbol representation.", "id": "GoogleCloudVisionV1p4beta1Symbol", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float" }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "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)." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse", "description": "A list of file annotation responses.", "type": "object", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest." } } }, "GoogleCloudVisionV1p3beta1Symbol": { "type": "object", "properties": { "property": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "description": "Additional information detected for the symbol." }, "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." } }, "id": "GoogleCloudVisionV1p3beta1Symbol", "description": "A single symbol representation." }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { "properties": { "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." ], "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" ] }, "position": { "$ref": "GoogleCloudVisionV1p3beta1Position", "description": "Face landmark position." } }, "type": "object", "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`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark" }, "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": { "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel", "description": "Label to provide extra metadata for the web detection.", "type": "object", "properties": { "label": { "description": "Label for extra metadata.", "type": "string" }, "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." } } }, "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation": { "properties": { "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" }, "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": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Set of detected objects with bounding boxes.", "id": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, "GoogleCloudVisionV1p2beta1InputConfig": { "properties": { "content": { "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.", "format": "byte" }, "mimeType": { "type": "string", "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported." }, "gcsSource": { "$ref": "GoogleCloudVisionV1p2beta1GcsSource", "description": "The Google Cloud Storage location to read the input from." } }, "type": "object", "description": "The desired input location and metadata.", "id": "GoogleCloudVisionV1p2beta1InputConfig" }, "Symbol": { "properties": { "property": { "$ref": "TextProperty", "description": "Additional information detected for the symbol." }, "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" }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" } }, "type": "object", "description": "A single symbol representation.", "id": "Symbol" }, "GoogleCloudVisionV1p2beta1ImageContext": { "type": "object", "properties": { "latLongRect": { "description": "Not used.", "$ref": "GoogleCloudVisionV1p2beta1LatLongRect" }, "productSearchParams": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchParams", "description": "Parameters for product search." }, "textDetectionParams": { "description": "Parameters for text detection and document text detection.", "$ref": "GoogleCloudVisionV1p2beta1TextDetectionParams" }, "webDetectionParams": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionParams", "description": "Parameters for web detection." }, "languageHints": { "items": { "type": "string" }, "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)." }, "cropHintsParams": { "description": "Parameters for crop hints annotation request.", "$ref": "GoogleCloudVisionV1p2beta1CropHintsParams" } }, "id": "GoogleCloudVisionV1p2beta1ImageContext", "description": "Image context and/or feature-specific parameters." }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { "type": "object", "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult" } }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "The bounding polygon around the product detected in the query image." }, "objectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation" }, "type": "array", "description": "List of generic predictions for the object in the bounding box." } }, "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "description": "Information about the products similar to a single product in a query image." }, "GoogleCloudVisionV1p4beta1Product": { "type": "object", "properties": { "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "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": { "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" } }, "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." } }, "id": "GoogleCloudVisionV1p4beta1Product", "description": "A Product contains ReferenceImages." }, "GoogleCloudVisionV1p4beta1TextAnnotation": { "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "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": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Page" } }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } } }, "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request.", "type": "object", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p3beta1OutputConfig" } } }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest": { "properties": { "requests": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageRequest" }, "type": "array", "description": "Required. Individual image annotation requests for this batch." }, "parent": { "type": "string", "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`." }, "labels": { "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.", "type": "object" }, "outputConfig": { "description": "Required. The desired output location and metadata (e.g. format).", "$ref": "GoogleCloudVisionV1p2beta1OutputConfig" } }, "type": "object", "description": "Request for async image annotation for a list of images.", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "GoogleCloudVisionV1p2beta1WebDetectionWebPage": { "properties": { "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." }, "fullMatchingImages": { "description": "Fully matching images on the page. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "type": "array" }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "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": { "description": "The result web page URL.", "type": "string" } }, "type": "object", "description": "Metadata for web pages.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage" }, "GoogleCloudVisionV1p4beta1AnnotateImageResponse": { "id": "GoogleCloudVisionV1p4beta1AnnotateImageResponse", "description": "Response to an image annotation request.", "type": "object", "properties": { "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation" }, "error": { "$ref": "Status", "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." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1ImageProperties", "description": "If present, image properties were extracted successfully." }, "context": { "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "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." }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1WebDetection" }, "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" } }, "labelAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "faceAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotation" }, "type": "array", "description": "If present, face detection has completed successfully." }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" } }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResults" }, "localizedObjectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." } } }, "GoogleCloudVisionV1p4beta1WebDetectionWebLabel": { "description": "Label to provide extra metadata for the web detection.", "id": "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." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1Feature": { "type": "object", "properties": { "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." }, "type": { "type": "string", "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" ], "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." ], "description": "The feature type." }, "maxResults": { "type": "integer", "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "format": "int32" } }, "id": "GoogleCloudVisionV1p2beta1Feature", "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." }, "GoogleCloudVisionV1p2beta1CropHintsAnnotation": { "id": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "properties": { "cropHints": { "description": "Crop hint results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1CropHint" } } } }, "GoogleCloudVisionV1p4beta1Block": { "properties": { "blockType": { "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.", "type": "string", "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ] }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float", "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": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "items": { "$ref": "GoogleCloudVisionV1p4beta1Paragraph" }, "type": "array" }, "property": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty", "description": "Additional information detected for the block." } }, "type": "object", "description": "Logical element on the page.", "id": "GoogleCloudVisionV1p4beta1Block" }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { "type": "object", "properties": { "responses": { "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" } }, "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "inputConfig": { "$ref": "GoogleCloudVisionV1p3beta1InputConfig", "description": "Information about the file for which this response is generated." }, "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": "GoogleCloudVisionV1p3beta1AnnotateFileResponse", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses." }, "LatLng": { "properties": { "latitude": { "type": "number", "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double" }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double", "type": "number" } }, "type": "object", "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" }, "SafeSearchAnnotation": { "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" }, "adult": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "spoof": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "medical": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "racy": { "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." ], "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": "object", "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "SafeSearchAnnotation" }, "CropHintsAnnotation": { "type": "object", "properties": { "cropHints": { "description": "Crop hint results.", "items": { "$ref": "CropHint" }, "type": "array" } }, "id": "CropHintsAnnotation", "description": "Set of crop hints that are used to generate new crops when serving images." }, "GoogleCloudVisionV1p1beta1Property": { "id": "GoogleCloudVisionV1p1beta1Property", "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "properties": { "value": { "description": "Value of the property.", "type": "string" }, "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" }, "name": { "type": "string", "description": "Name of the property." } } }, "EntityAnnotation": { "id": "EntityAnnotation", "description": "Set of detected entity features.", "type": "object", "properties": { "boundingPoly": { "$ref": "BoundingPoly", "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", "type": "number" }, "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" }, "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" }, "locations": { "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" }, "type": "array" }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "confidence": { "deprecated": true, "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", "type": "number" }, "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." } } }, "BatchOperationMetadata": { "type": "object", "properties": { "state": { "description": "The current state of the batch operation.", "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" ], "type": "string" }, "submitTime": { "description": "The time when the batch request was submitted to the server.", "format": "google-datetime", "type": "string" }, "endTime": { "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime", "type": "string" } }, "id": "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." }, "GoogleCloudVisionV1p3beta1ReferenceImage": { "id": "GoogleCloudVisionV1p3beta1ReferenceImage", "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.", "type": "object", "properties": { "name": { "type": "string", "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." }, "uri": { "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" }, "boundingPolys": { "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", "items": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" } } } }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation", "properties": { "adult": { "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." ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities." }, "spoof": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "violence": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "medical": { "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." ], "description": "Likelihood that this is a medical image." }, "racy": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "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.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] } }, "type": "object" }, "KeyValue": { "type": "object", "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" } }, "id": "KeyValue", "description": "A product label represented as a key-value pair." }, "GoogleCloudVisionV1p2beta1Paragraph": { "properties": { "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected for the paragraph." }, "words": { "items": { "$ref": "GoogleCloudVisionV1p2beta1Word" }, "type": "array", "description": "List of all words in this paragraph." }, "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)." }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" } }, "type": "object", "description": "Structural unit of text representing a number of words in certain order.", "id": "GoogleCloudVisionV1p2beta1Paragraph" }, "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": { "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" }, "type": "array", "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." } }, "type": "object", "description": "Results for a product search request.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResults" }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { "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).", "type": "object", "properties": { "violence": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "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.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "adult": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "spoof": { "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "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" }, "medical": { "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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "racy": { "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." ], "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." } } }, "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty": { "type": "object", "properties": { "detectedLanguages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence." }, "detectedBreak": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a text segment." } }, "id": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected on the structural component." }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { "type": "object", "properties": { "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." ], "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" ] }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p1beta1Position" } }, "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`." }, "GoogleCloudVisionV1p2beta1Image": { "description": "Client image to perform Google Cloud Vision API tasks over.", "id": "GoogleCloudVisionV1p2beta1Image", "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": { "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.", "format": "byte" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1Block": { "type": "object", "properties": { "blockType": { "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.", "type": "string", "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ] }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" }, "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" }, "paragraphs": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Paragraph" }, "description": "List of paragraphs in this block (if this blocks is of type text)." }, "property": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "description": "Additional information detected for the block." } }, "id": "GoogleCloudVisionV1p3beta1Block", "description": "Logical element on the page." }, "WebLabel": { "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": { "type": "string", "description": "Label for extra metadata." } }, "id": "WebLabel", "description": "Label to provide extra metadata for the web detection." }, "GoogleCloudVisionV1p3beta1DominantColorsAnnotation": { "type": "object", "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ColorInfo" }, "type": "array" } }, "id": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p4beta1GcsSource": { "id": "GoogleCloudVisionV1p4beta1GcsSource", "description": "The Google Cloud Storage location where the input will be read from.", "type": "object", "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." } } }, "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.", "id": "TextAnnotation", "properties": { "pages": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "Page" } }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { "id": "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`.", "type": "object", "properties": { "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." ], "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" ] }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p2beta1Position" } } }, "AnnotateFileResponse": { "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "AnnotateFileResponse", "properties": { "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "InputConfig" }, "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": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "responses": { "type": "array", "items": { "$ref": "AnnotateImageResponse" }, "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set." } }, "type": "object" }, "GoogleCloudVisionV1p3beta1ProductSearchResults": { "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": "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." }, "results": { "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "type": "array", "description": "List of results, one for each product match." } }, "type": "object", "description": "Results for a product search request.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResults" }, "BoundingPoly": { "type": "object", "properties": { "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "Vertex" } }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "NormalizedVertex" } } }, "id": "BoundingPoly", "description": "A bounding polygon for the detected image annotation." }, "GoogleCloudVisionV1p3beta1ProductKeyValue": { "type": "object", "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" } }, "id": "GoogleCloudVisionV1p3beta1ProductKeyValue", "description": "A product label represented as a key-value pair." }, "GoogleCloudVisionV1p2beta1WebDetectionParams": { "type": "object", "properties": { "includeGeoResults": { "deprecated": true, "description": "This field has no effect on results.", "type": "boolean" } }, "id": "GoogleCloudVisionV1p2beta1WebDetectionParams", "description": "Parameters for web detection request." }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { "properties": { "uri": { "type": "string", "description": "The URI of the file used to produce the image." }, "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", "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.", "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext" }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage": { "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": { "type": "number", "description": "Confidence of detected language. Range [0, 1].", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage", "description": "Detected language for a structural component." }, "GoogleCloudVisionV1p1beta1WebDetectionWebImage": { "description": "Metadata for online images.", "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage", "properties": { "url": { "description": "The result image URL.", "type": "string" }, "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1LocationInfo": { "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "type": "object", "description": "Detected entity location information.", "id": "GoogleCloudVisionV1p1beta1LocationInfo" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsResult": { "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p1beta1Product" }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" } }, "type": "object", "description": "Information about a product.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" }, "FaceAnnotation": { "id": "FaceAnnotation", "description": "A face annotation object contains the results of face detection.", "type": "object", "properties": { "landmarkingConfidence": { "type": "number", "description": "Face landmarking confidence. Range [0, 1].", "format": "float" }, "headwearLikelihood": { "description": "Headwear 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" }, "angerLikelihood": { "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." ], "description": "Anger likelihood." }, "fdBoundingPoly": { "$ref": "BoundingPoly", "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." }, "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "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." ] }, "rollAngle": { "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].", "format": "float" }, "underExposedLikelihood": { "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." ], "description": "Under-exposed likelihood." }, "joyLikelihood": { "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." ], "description": "Joy 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" }, "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" }, "landmarks": { "type": "array", "items": { "$ref": "Landmark" }, "description": "Detected face landmarks." }, "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" }, "blurredLikelihood": { "description": "Blurred 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" }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "format": "float", "type": "number" }, "sorrowLikelihood": { "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." ], "description": "Sorrow likelihood." } } }, "GoogleCloudVisionV1p1beta1ImageProperties": { "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation" } }, "type": "object", "description": "Stores image properties, such as dominant colors.", "id": "GoogleCloudVisionV1p1beta1ImageProperties" }, "GoogleCloudVisionV1p4beta1OperationMetadata": { "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "type": "string", "description": "Current state of the batch operation.", "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ] }, "createTime": { "description": "The time when the batch request was received.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" } }, "type": "object", "description": "Contains metadata for the BatchAnnotateImages operation.", "id": "GoogleCloudVisionV1p4beta1OperationMetadata" }, "LocationInfo": { "description": "Detected entity location information.", "id": "LocationInfo", "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotation": { "id": "GoogleCloudVisionV1p2beta1TextAnnotation", "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": "GoogleCloudVisionV1p2beta1Page" }, "type": "array", "description": "List of pages detected by OCR." }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } } }, "GoogleCloudVisionV1p3beta1WebDetectionWebImage": { "id": "GoogleCloudVisionV1p3beta1WebDetectionWebImage", "description": "Metadata for online images.", "type": "object", "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" } } }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest": { "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": { "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.", "type": "object" }, "requests": { "description": "Required. Individual async file annotation requests for this batch.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest" }, "type": "array" } }, "type": "object", "description": "Multiple async file annotation requests are batched into a single service call.", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty": { "description": "Additional information detected on the structural component.", "id": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty", "properties": { "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage" } }, "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1Page": { "description": "Detected page from OCR.", "id": "GoogleCloudVisionV1p2beta1Page", "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "confidence": { "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float", "type": "number" }, "width": { "type": "integer", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "height": { "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, "blocks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Block" }, "description": "List of blocks of text, images etc on this page." } }, "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": { "description": "Entity deduced from similar images on the Internet.", "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity", "properties": { "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" }, "entityId": { "description": "Opaque entity ID.", "type": "string" }, "description": { "type": "string", "description": "Canonical description of the entity, in English." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1Page": { "properties": { "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.", "items": { "$ref": "GoogleCloudVisionV1p4beta1Block" }, "type": "array" }, "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Detected page from OCR.", "id": "GoogleCloudVisionV1p4beta1Page" }, "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty": { "id": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "description": "Additional information detected on the structural component.", "type": "object", "properties": { "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage" } }, "detectedBreak": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a text segment." } } }, "NormalizedVertex": { "id": "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.", "type": "object", "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "description": "Y coordinate.", "format": "float", "type": "number" } } }, "WebImage": { "properties": { "url": { "description": "The result image URL.", "type": "string" }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" } }, "type": "object", "description": "Metadata for online images.", "id": "WebImage" }, "AsyncBatchAnnotateImagesResponse": { "description": "Response to an async batch image annotation request.", "id": "AsyncBatchAnnotateImagesResponse", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest.", "$ref": "OutputConfig" } }, "type": "object" }, "Property": { "id": "Property", "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "properties": { "value": { "description": "Value of the property.", "type": "string" }, "uint64Value": { "description": "Value of numeric properties.", "format": "uint64", "type": "string" }, "name": { "description": "Name of the property.", "type": "string" } } }, "GoogleCloudVisionV1p2beta1GcsSource": { "id": "GoogleCloudVisionV1p2beta1GcsSource", "description": "The Google Cloud Storage location where the input will be read from.", "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" } } }, "GoogleCloudVisionV1p1beta1ProductSearchResults": { "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "description": "Results for a product search request.", "type": "object", "properties": { "results": { "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" }, "type": "array", "description": "List of results, one for each product match." }, "indexTime": { "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", "type": "string" }, "productGroupedResults": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" }, "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." } } }, "GoogleCloudVisionV1p2beta1DominantColorsAnnotation": { "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ColorInfo" } } }, "type": "object", "description": "Set of dominant colors and their corresponding scores.", "id": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation" }, "GoogleCloudVisionV1p4beta1Position": { "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", "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "z": { "description": "Z coordinate (or depth).", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { "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": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "referenceImages": { "description": "The list of reference_images that are imported successfully.", "items": { "$ref": "GoogleCloudVisionV1p3beta1ReferenceImage" }, "type": "array" }, "statuses": { "type": "array", "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": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "id": "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].", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1WebDetection": { "type": "object", "properties": { "webEntities": { "description": "Deduced entities from similar images on the Internet.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity" }, "type": "array" }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "type": "array" }, "pagesWithMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebPage" }, "type": "array", "description": "Web pages containing the matching images from the Internet." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "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": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "type": "array", "description": "The visually similar image results." }, "bestGuessLabels": { "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" }, "type": "array" } }, "id": "GoogleCloudVisionV1p4beta1WebDetection", "description": "Relevant information for the image from the Internet." }, "GoogleCloudVisionV1p2beta1CropHint": { "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." }, "confidence": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { "type": "number", "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float" } }, "type": "object", "description": "Single crop hint that is used to generate a new crop when serving an image.", "id": "GoogleCloudVisionV1p2beta1CropHint" }, "GoogleCloudVisionV1p4beta1OutputConfig": { "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": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p4beta1GcsDestination" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { "properties": { "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." ], "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" ] }, "position": { "$ref": "GoogleCloudVisionV1p4beta1Position", "description": "Face landmark position." } }, "type": "object", "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`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark" }, "WebEntity": { "description": "Entity deduced from similar images on the Internet.", "id": "WebEntity", "properties": { "entityId": { "description": "Opaque entity ID.", "type": "string" }, "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileRequest": { "type": "object", "properties": { "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Required. Information about the input file." }, "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "pages": { "items": { "format": "int32", "type": "integer" }, "type": "array", "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." }, "features": { "description": "Required. Requested features.", "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "type": "array" } }, "id": "GoogleCloudVisionV1p2beta1AnnotateFileRequest", "description": "A request to annotate one single file, e.g. a PDF, TIFF or GIF file." }, "GoogleCloudVisionV1p2beta1GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "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" } }, "type": "object" }, "DominantColorsAnnotation": { "type": "object", "properties": { "colors": { "type": "array", "items": { "$ref": "ColorInfo" }, "description": "RGB color values with their score and pixel fraction." } }, "id": "DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { "properties": { "violence": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "adult": { "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." ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities." }, "spoof": { "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." ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive." }, "medical": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "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." ] }, "racy": { "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.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] } }, "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).", "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation" }, "InputConfig": { "description": "The desired input location and metadata.", "id": "InputConfig", "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" }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GcsSource" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation", "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "type": "object", "properties": { "racy": { "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." ], "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": { "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" }, "adult": { "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." ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities." }, "spoof": { "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." ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive." }, "medical": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "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." ] } } }, "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].", "format": "float", "type": "number" }, "alpha": { "type": "number", "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).", "format": "float" }, "red": { "type": "number", "description": "The amount of red in the color as a value in the interval [0, 1].", "format": "float" }, "green": { "description": "The amount of green in the color as a value in the interval [0, 1].", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1LocationInfo": { "description": "Detected entity location information.", "id": "GoogleCloudVisionV1p4beta1LocationInfo", "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "type": "object" }, "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.", "type": "object", "properties": { "imageContext": { "description": "Additional context that may accompany the image.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "image": { "$ref": "GoogleCloudVisionV1p2beta1Image", "description": "The image to be processed." }, "features": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "description": "Requested features." } } }, "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request.", "type": "object", "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p2beta1OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } } }, "GoogleCloudVisionV1p1beta1CropHint": { "id": "GoogleCloudVisionV1p1beta1CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object", "properties": { "boundingPoly": { "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "confidence": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { "type": "number", "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float" } } }, "GoogleCloudVisionV1p1beta1AnnotateImageResponse": { "description": "Response to an image annotation request.", "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse", "properties": { "error": { "$ref": "Status", "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." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p1beta1ImageProperties" }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation" }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation" }, "type": "array" }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "logoAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully." }, "labelAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "localizedObjectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, "type": "array", "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "productSearchResults": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResults", "description": "If present, product search has completed successfully." }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext" }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation", "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." }, "webDetection": { "$ref": "GoogleCloudVisionV1p1beta1WebDetection", "description": "If present, web detection has completed successfully." }, "landmarkAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "type": "array", "description": "If present, landmark detection has completed successfully." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1InputConfig": { "properties": { "content": { "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.", "format": "byte" }, "mimeType": { "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.", "type": "string" }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p4beta1GcsSource" } }, "type": "object", "description": "The desired input location and metadata.", "id": "GoogleCloudVisionV1p4beta1InputConfig" }, "GoogleCloudVisionV1p4beta1FaceAnnotation": { "properties": { "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" }, "joyLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Joy likelihood.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "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" }, "detectionConfidence": { "type": "number", "description": "Detection confidence. Range [0, 1].", "format": "float" }, "sorrowLikelihood": { "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." ], "description": "Sorrow likelihood." }, "landmarks": { "description": "Detected face landmarks.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark" } }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "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." }, "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" ] }, "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": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "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" ] }, "rollAngle": { "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].", "format": "float" }, "underExposedLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "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": { "type": "number", "description": "Face landmarking confidence. Range [0, 1].", "format": "float" }, "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Headwear likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "angerLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "recognitionResult": { "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "type": "array", "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." } }, "type": "object", "description": "A face annotation object contains the results of face detection.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotation" }, "ReferenceImage": { "type": "object", "properties": { "name": { "type": "string", "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." }, "uri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`." }, "boundingPolys": { "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", "items": { "$ref": "BoundingPoly" } } }, "id": "ReferenceImage", "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes." }, "GoogleCloudVisionV1p2beta1WebDetectionWebLabel": { "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": { "type": "string", "description": "Label for extra metadata." } }, "type": "object", "description": "Label to provide extra metadata for the web detection.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "GoogleCloudVisionV1p1beta1Block": { "properties": { "blockType": { "type": "string", "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "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." }, "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float", "type": "number" }, "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)." }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Paragraph" } }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" } }, "type": "object", "description": "Logical element on the page.", "id": "GoogleCloudVisionV1p1beta1Block" }, "GoogleCloudVisionV1p2beta1TextDetectionParams": { "properties": { "advancedOcrOptions": { "type": "array", "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." }, "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." } }, "type": "object", "description": "Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.", "id": "GoogleCloudVisionV1p2beta1TextDetectionParams" }, "GoogleCloudVisionV1p3beta1FaceAnnotation": { "properties": { "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." }, "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].", "format": "float", "type": "number" }, "underExposedLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "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." ] }, "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" }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "headwearLikelihood": { "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", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "detectionConfidence": { "type": "number", "description": "Detection confidence. Range [0, 1].", "format": "float" }, "sorrowLikelihood": { "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." ], "description": "Sorrow likelihood." }, "landmarks": { "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark" }, "type": "array", "description": "Detected face landmarks." }, "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." }, "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" ] }, "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" }, "joyLikelihood": { "description": "Joy 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" }, "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" } }, "type": "object", "description": "A face annotation object contains the results of face detection.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotation" }, "GoogleCloudVisionV1p4beta1BoundingPoly": { "type": "object", "properties": { "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Vertex" } }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "items": { "$ref": "GoogleCloudVisionV1p4beta1NormalizedVertex" }, "type": "array" } }, "id": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "A bounding polygon for the detected image annotation." }, "GoogleCloudVisionV1p2beta1WebDetectionWebEntity": { "properties": { "entityId": { "type": "string", "description": "Opaque entity ID." }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "score": { "type": "number", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float" } }, "type": "object", "description": "Entity deduced from similar images on the Internet.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation": { "properties": { "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" }, "name": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Prediction for what the object in the bounding box is.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation" }, "GoogleCloudVisionV1p1beta1CropHintsAnnotation": { "type": "object", "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1CropHint" }, "description": "Crop hint results." } }, "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", "description": "Set of crop hints that are used to generate new crops when serving images." }, "GcsSource": { "type": "object", "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." } }, "id": "GcsSource", "description": "The Google Cloud Storage location where the input will be read from." }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { "properties": { "y": { "type": "number", "description": "Y coordinate.", "format": "float" }, "x": { "type": "number", "description": "X coordinate.", "format": "float" } }, "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.", "id": "GoogleCloudVisionV1p3beta1NormalizedVertex" }, "GoogleCloudVisionV1p3beta1Product": { "description": "A Product contains ReferenceImages.", "id": "GoogleCloudVisionV1p3beta1Product", "properties": { "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." }, "displayName": { "type": "string", "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long." }, "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": { "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": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, "type": "array" }, "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" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { "properties": { "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation" }, "type": "array" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "The bounding polygon around the product detected in the query image." }, "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" } } }, "type": "object", "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, "Operation": { "properties": { "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "type": "object", "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." } }, "done": { "type": "boolean", "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." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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`.", "type": "object" }, "name": { "type": "string", "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": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation" }, "TextProperty": { "properties": { "detectedBreak": { "$ref": "DetectedBreak", "description": "Detected start or end of a text segment." }, "detectedLanguages": { "items": { "$ref": "DetectedLanguage" }, "type": "array", "description": "A list of detected languages together with confidence." } }, "type": "object", "description": "Additional information detected on the structural component.", "id": "TextProperty" }, "GoogleCloudVisionV1p2beta1ProductSearchResults": { "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "description": "Results for a product search request.", "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "indexTime": { "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", "type": "string" }, "productGroupedResults": { "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" }, "type": "array", "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." } } }, "GoogleCloudVisionV1p4beta1ProductSearchResultsResult": { "description": "Information about a product.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "product": { "$ref": "GoogleCloudVisionV1p4beta1Product", "description": "The Product." }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest": { "properties": { "features": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Feature" }, "description": "Required. Requested features." }, "inputConfig": { "$ref": "GoogleCloudVisionV1p2beta1InputConfig", "description": "Required. Information about the input file." }, "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p2beta1ImageContext" }, "outputConfig": { "$ref": "GoogleCloudVisionV1p2beta1OutputConfig", "description": "Required. The desired output location and metadata (e.g. format)." } }, "type": "object", "description": "An offline file annotation request.", "id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileRequest" }, "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request.", "type": "object", "properties": { "outputConfig": { "$ref": "GoogleCloudVisionV1p1beta1OutputConfig", "description": "The output location and metadata from AsyncAnnotateFileRequest." } } }, "GoogleCloudVisionV1p3beta1Paragraph": { "id": "GoogleCloudVisionV1p3beta1Paragraph", "description": "Structural unit of text representing a number of words in certain order.", "type": "object", "properties": { "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": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Word" } }, "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" } } }, "GoogleCloudVisionV1p1beta1ProductKeyValue": { "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": "GoogleCloudVisionV1p1beta1ProductKeyValue" }, "GoogleCloudVisionV1p2beta1Block": { "properties": { "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float", "type": "number" }, "blockType": { "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." ], "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "type": "string" }, "property": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "description": "Additional information detected for the block." }, "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" }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "items": { "$ref": "GoogleCloudVisionV1p2beta1Paragraph" }, "type": "array" } }, "type": "object", "description": "Logical element on the page.", "id": "GoogleCloudVisionV1p2beta1Block" }, "GoogleCloudVisionV1p4beta1WebDetectionWebEntity": { "id": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity", "description": "Entity deduced from similar images on the Internet.", "type": "object", "properties": { "entityId": { "description": "Opaque entity ID.", "type": "string" }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p3beta1WebDetection": { "properties": { "visuallySimilarImages": { "description": "The visually similar image results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" } }, "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": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel" } }, "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": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array" }, "pagesWithMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet." }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "webEntities": { "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity" }, "type": "array", "description": "Deduced entities from similar images on the Internet." } }, "type": "object", "description": "Relevant information for the image from the Internet.", "id": "GoogleCloudVisionV1p3beta1WebDetection" }, "GoogleCloudVisionV1p1beta1Position": { "type": "object", "properties": { "y": { "description": "Y coordinate.", "format": "float", "type": "number" }, "z": { "type": "number", "description": "Z coordinate (or depth).", "format": "float" }, "x": { "description": "X coordinate.", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p1beta1Position", "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." }, "GoogleCloudVisionV1p2beta1ProductSearchParams": { "properties": { "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" }, "filter": { "type": "string", "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 '='." }, "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.", "type": "array", "items": { "type": "string" } }, "boundingPoly": { "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" } }, "type": "object", "description": "Parameters for a product search request.", "id": "GoogleCloudVisionV1p2beta1ProductSearchParams" }, "GoogleCloudVisionV1p2beta1FaceAnnotation": { "id": "GoogleCloudVisionV1p2beta1FaceAnnotation", "description": "A face annotation object contains the results of face detection.", "type": "object", "properties": { "landmarkingConfidence": { "type": "number", "description": "Face landmarking confidence. Range [0, 1].", "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.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "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" }, "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" }, "surpriseLikelihood": { "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" ], "type": "string" }, "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].", "format": "float", "type": "number" }, "underExposedLikelihood": { "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "description": "Under-exposed likelihood.", "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "joyLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Joy likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "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" }, "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" }, "landmarks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks." }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "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." }, "blurredLikelihood": { "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." ], "description": "Blurred likelihood." }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "format": "float", "type": "number" }, "sorrowLikelihood": { "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": "string" } } }, "OutputConfig": { "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GcsDestination" }, "batchSize": { "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.", "format": "int32" } }, "type": "object", "description": "The desired output location and metadata.", "id": "OutputConfig" }, "GoogleCloudVisionV1p2beta1LocationInfo": { "id": "GoogleCloudVisionV1p2beta1LocationInfo", "description": "Detected entity location information.", "type": "object", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } } }, "GoogleCloudVisionV1p4beta1WebDetectionWebPage": { "type": "object", "properties": { "partialMatchingImages": { "type": "array", "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." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "url": { "type": "string", "description": "The result web page URL." }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "fullMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "type": "array", "description": "Fully matching images on the page. Can include resized copies of the query image." } }, "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage", "description": "Metadata for web pages." }, "GoogleCloudVisionV1p2beta1Symbol": { "description": "A single symbol representation.", "id": "GoogleCloudVisionV1p2beta1Symbol", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float" }, "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "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)." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { "properties": { "referenceImages": { "items": { "$ref": "GoogleCloudVisionV1p4beta1ReferenceImage" }, "type": "array", "description": "The list of reference_images that are imported successfully." }, "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.", "type": "array", "items": { "$ref": "Status" } } }, "type": "object", "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": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse" }, "GoogleCloudVisionV1p2beta1WebDetection": { "type": "object", "properties": { "partialMatchingImages": { "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "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." }, "visuallySimilarImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "description": "The visually similar image results." }, "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": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" } }, "webEntities": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity" }, "description": "Deduced entities from similar images on the Internet." }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "type": "array" }, "pagesWithMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet." } }, "id": "GoogleCloudVisionV1p2beta1WebDetection", "description": "Relevant information for the image from the Internet." }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { "properties": { "y": { "description": "Y coordinate.", "format": "float", "type": "number" }, "x": { "description": "X coordinate.", "format": "float", "type": "number" } }, "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.", "id": "GoogleCloudVisionV1p2beta1NormalizedVertex" }, "BatchAnnotateFilesResponse": { "id": "BatchAnnotateFilesResponse", "description": "A list of file annotation responses.", "type": "object", "properties": { "responses": { "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "AnnotateFileResponse" } } } }, "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": { "type": "number", "description": "Confidence of detected language. Range [0, 1].", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1GcsSource": { "type": "object", "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." } }, "id": "GoogleCloudVisionV1p3beta1GcsSource", "description": "The Google Cloud Storage location where the input will be read from." }, "GoogleCloudVisionV1p2beta1WebDetectionWebImage": { "description": "Metadata for online images.", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebImage", "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse": { "description": "Response to a batch image annotation request.", "id": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse", "properties": { "responses": { "description": "Individual responses to image annotation requests within the batch.", "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, "type": "array" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1ImageProperties": { "description": "Stores image properties, such as dominant colors.", "id": "GoogleCloudVisionV1p3beta1ImageProperties", "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "type": "object" }, "GoogleCloudVisionV1p3beta1OutputConfig": { "description": "The desired output location and metadata.", "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "batchSize": { "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.", "format": "int32" }, "gcsDestination": { "$ref": "GoogleCloudVisionV1p3beta1GcsDestination", "description": "The Google Cloud Storage location to write the output(s) to." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { "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", "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." } }, "type": "object" }, "Result": { "id": "Result", "description": "Information about a product.", "type": "object", "properties": { "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { "$ref": "Product", "description": "The Product." } } }, "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse": { "type": "object", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p4beta1OutputConfig" } }, "id": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse", "description": "The response for a single offline file annotation request." }, "GoogleCloudVisionV1p2beta1Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudVisionV1p2beta1Vertex", "properties": { "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" }, "x": { "description": "X coordinate.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1GcsDestination": { "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": "GoogleCloudVisionV1p4beta1GcsDestination", "description": "The Google Cloud Storage location where the output will be written to." }, "GoogleCloudVisionV1p3beta1Property": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the property." }, "value": { "description": "Value of the property.", "type": "string" }, "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" } }, "id": "GoogleCloudVisionV1p3beta1Property", "description": "A `Property` consists of a user-supplied name/value pair." }, "GoogleCloudVisionV1p4beta1Property": { "description": "A `Property` consists of a user-supplied name/value pair.", "id": "GoogleCloudVisionV1p4beta1Property", "properties": { "value": { "type": "string", "description": "Value of the property." }, "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" }, "name": { "description": "Name of the property.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation": { "id": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation", "description": "Set of detected objects with bounding boxes.", "type": "object", "properties": { "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" }, "name": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "Image region to which this object belongs. This must be populated." }, "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" } } }, "Product": { "id": "Product", "description": "A Product contains ReferenceImages.", "type": "object", "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": { "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": "KeyValue" }, "type": "array" }, "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." }, "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." } } }, "GoogleCloudVisionV1p3beta1CropHint": { "type": "object", "properties": { "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale." }, "confidence": { "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image." }, "GoogleCloudVisionV1p3beta1Word": { "type": "object", "properties": { "property": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "description": "Additional information detected for the word." }, "boundingBox": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "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)." }, "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" } }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1Word", "description": "A word representation." }, "GoogleCloudVisionV1p3beta1AnnotateImageResponse": { "type": "object", "properties": { "error": { "$ref": "Status", "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." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p3beta1ImageProperties" }, "safeSearchAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "type": "array" }, "labelAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" } }, "faceAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotation" }, "description": "If present, face detection has completed successfully." }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResults" }, "localizedObjectAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" }, "type": "array", "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "context": { "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext", "description": "If present, contextual information is needed to understand where this image comes from." }, "landmarkAnnotations": { "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "type": "array", "description": "If present, landmark detection has completed successfully." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation", "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." }, "webDetection": { "$ref": "GoogleCloudVisionV1p3beta1WebDetection", "description": "If present, web detection has completed successfully." } }, "id": "GoogleCloudVisionV1p3beta1AnnotateImageResponse", "description": "Response to an image annotation request." }, "Word": { "type": "object", "properties": { "boundingBox": { "$ref": "BoundingPoly", "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)." }, "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "Symbol" } }, "property": { "$ref": "TextProperty", "description": "Additional information detected for the word." }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float" } }, "id": "Word", "description": "A word representation." }, "Block": { "id": "Block", "description": "Logical element on the page.", "type": "object", "properties": { "blockType": { "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.", "type": "string", "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ] }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" }, "boundingBox": { "$ref": "BoundingPoly", "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)." }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "Paragraph" } }, "property": { "$ref": "TextProperty", "description": "Additional information detected for the block." } } }, "GoogleCloudVisionV1p3beta1EntityAnnotation": { "id": "GoogleCloudVisionV1p3beta1EntityAnnotation", "description": "Set of detected entity features.", "type": "object", "properties": { "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", "type": "number" }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "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" }, "locations": { "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "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." }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "confidence": { "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", "deprecated": true }, "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." } } }, "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest": { "properties": { "requests": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateFileRequest" }, "type": "array", "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest." }, "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" } } }, "type": "object", "description": "A list of requests to annotate files using the BatchAnnotateFiles API.", "id": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest": { "description": "Multiple image annotation requests are batched into a single service call.", "id": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest", "properties": { "requests": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AnnotateImageRequest" }, "type": "array", "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": { "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" } } }, "type": "object" }, "WebDetection": { "id": "WebDetection", "description": "Relevant information for the image from the Internet.", "type": "object", "properties": { "visuallySimilarImages": { "items": { "$ref": "WebImage" }, "type": "array", "description": "The visually similar image results." }, "bestGuessLabels": { "items": { "$ref": "WebLabel" }, "type": "array", "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web." }, "partialMatchingImages": { "items": { "$ref": "WebImage" }, "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." }, "pagesWithMatchingImages": { "description": "Web pages containing the matching images from the Internet.", "type": "array", "items": { "$ref": "WebPage" } }, "fullMatchingImages": { "items": { "$ref": "WebImage" }, "type": "array", "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "webEntities": { "items": { "$ref": "WebEntity" }, "type": "array", "description": "Deduced entities from similar images on the Internet." } } }, "GroupedResult": { "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "Result" } }, "boundingPoly": { "$ref": "BoundingPoly", "description": "The bounding polygon around the product detected in the query image." }, "objectAnnotations": { "type": "array", "items": { "$ref": "ObjectAnnotation" }, "description": "List of generic predictions for the object in the bounding box." } }, "type": "object", "description": "Information about the products similar to a single product in a query image.", "id": "GroupedResult" }, "ProductSearchResults": { "type": "object", "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "Result" } }, "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": { "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" } }, "id": "ProductSearchResults", "description": "Results for a product search request." }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult", "properties": { "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation" } }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly", "description": "The bounding polygon around the product detected in the query image." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse", "description": "Response to an async batch file annotation request.", "type": "object", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } } }, "ImageProperties": { "description": "Stores image properties, such as dominant colors.", "id": "ImageProperties", "properties": { "dominantColors": { "$ref": "DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1EntityAnnotation": { "description": "Set of detected entity features.", "id": "GoogleCloudVisionV1p4beta1EntityAnnotation", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly", "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "score": { "type": "number", "description": "Overall score of the result. Range [0, 1].", "format": "float" }, "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "mid": { "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).", "type": "string" }, "confidence": { "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", "deprecated": true }, "properties": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" }, "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": { "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": { "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocationInfo" } } }, "type": "object" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation": { "properties": { "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "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": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Prediction for what the object in the bounding box is.", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation" }, "GoogleCloudVisionV1p3beta1TextAnnotation": { "type": "object", "properties": { "pages": { "items": { "$ref": "GoogleCloudVisionV1p3beta1Page" }, "type": "array", "description": "List of pages detected by OCR." }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "id": "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." }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { "type": "object", "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "description": "Y coordinate.", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p1beta1NormalizedVertex", "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." }, "GoogleCloudVisionV1p2beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "id": "GoogleCloudVisionV1p2beta1BoundingPoly", "properties": { "vertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Vertex" }, "description": "The bounding polygon vertices." }, "normalizedVertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1NormalizedVertex" }, "description": "The bounding polygon normalized vertices." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1FaceRecognitionResult": { "properties": { "celebrity": { "$ref": "GoogleCloudVisionV1p4beta1Celebrity", "description": "The Celebrity that this face was matched to." }, "confidence": { "description": "Recognition confidence. Range [0, 1].", "format": "float", "type": "number" } }, "type": "object", "description": "Information about a face's identity.", "id": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "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`.", "id": "Landmark", "properties": { "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." ], "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" ] }, "position": { "$ref": "Position", "description": "Face landmark position." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1CropHintsAnnotation": { "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1CropHint" }, "description": "Crop hint results." } }, "type": "object", "description": "Set of crop hints that are used to generate new crops when serving images.", "id": "GoogleCloudVisionV1p4beta1CropHintsAnnotation" }, "GoogleCloudVisionV1p1beta1OutputConfig": { "description": "The desired output location and metadata.", "id": "GoogleCloudVisionV1p1beta1OutputConfig", "properties": { "batchSize": { "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.", "format": "int32" }, "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p1beta1GcsDestination" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateImageResponse": { "properties": { "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." }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1WebDetection" }, "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "cropHintsAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", "description": "If present, crop hints have completed successfully." }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext" }, "localizedObjectAnnotations": { "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" }, "type": "array" }, "productSearchResults": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResults", "description": "If present, product search has completed successfully." }, "faceAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotation" }, "description": "If present, face detection has completed successfully." }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" } }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "type": "array" }, "safeSearchAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation", "description": "If present, safe-search annotation has completed successfully." }, "imagePropertiesAnnotation": { "$ref": "GoogleCloudVisionV1p2beta1ImageProperties", "description": "If present, image properties were extracted 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", "description": "Response to an image annotation request.", "id": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" }, "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": { "x": { "type": "integer", "description": "X coordinate.", "format": "int32" }, "y": { "type": "integer", "description": "Y coordinate.", "format": "int32" } } }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { "description": "Information about the products similar to a single product in a query image.", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "properties": { "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "description": "The bounding polygon around the product detected in the query image." }, "results": { "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" }, "type": "array", "description": "List of results, one for each product match." }, "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation" }, "type": "array" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1EntityAnnotation": { "description": "Set of detected entity features.", "id": "GoogleCloudVisionV1p2beta1EntityAnnotation", "properties": { "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", "type": "number" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly", "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features." }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "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": { "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": "GoogleCloudVisionV1p2beta1LocationInfo" }, "type": "array" }, "properties": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" }, "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity." }, "mid": { "type": "string", "description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)." }, "confidence": { "deprecated": true, "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", "type": "number" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse", "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": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, "type": "array" } } }, "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation": { "properties": { "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "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": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "boundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "description": "Image region to which this object belongs. This must be populated." }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Set of detected objects with bounding boxes.", "id": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, "GoogleCloudVisionV1p2beta1ColorInfo": { "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p2beta1ColorInfo", "properties": { "color": { "description": "RGB components of the color.", "$ref": "Color" }, "score": { "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float", "type": "number" }, "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsResult": { "description": "Information about a product.", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p2beta1Product" }, "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" } }, "type": "object" }, "ImportProductSetsResponse": { "properties": { "statuses": { "type": "array", "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." }, "referenceImages": { "description": "The list of reference_images that are imported successfully.", "type": "array", "items": { "$ref": "ReferenceImage" } } }, "type": "object", "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" }, "GoogleCloudVisionV1p4beta1DominantColorsAnnotation": { "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ColorInfo" } } }, "type": "object", "description": "Set of dominant colors and their corresponding scores.", "id": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation" }, "GoogleCloudVisionV1p4beta1Vertex": { "id": "GoogleCloudVisionV1p4beta1Vertex", "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": { "type": "integer", "description": "Y coordinate.", "format": "int32" } } }, "GoogleCloudVisionV1p1beta1Paragraph": { "type": "object", "properties": { "property": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected for the paragraph." }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Word" } }, "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" } }, "id": "GoogleCloudVisionV1p1beta1Paragraph", "description": "Structural unit of text representing a number of words in certain order." }, "AsyncBatchAnnotateFilesResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "AsyncAnnotateFileResponse" }, "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "id": "AsyncBatchAnnotateFilesResponse", "description": "Response to an async batch file annotation request." }, "GoogleCloudVisionV1p3beta1WebDetectionWebEntity": { "id": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity", "description": "Entity deduced from similar images on the Internet.", "type": "object", "properties": { "entityId": { "type": "string", "description": "Opaque entity ID." }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "score": { "type": "number", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float" } } }, "GoogleCloudVisionV1p4beta1Celebrity": { "description": "A Celebrity is a group of Faces with an identity.", "id": "GoogleCloudVisionV1p4beta1Celebrity", "properties": { "name": { "type": "string", "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`." }, "displayName": { "type": "string", "description": "The Celebrity's display name." }, "description": { "description": "The Celebrity's description.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation": { "description": "Set of detected objects with bounding boxes.", "id": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation", "properties": { "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" }, "name": { "description": "Object name, expressed in its `language_code` language.", "type": "string" }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "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" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1LocationInfo": { "properties": { "latLng": { "$ref": "LatLng", "description": "lat/long location coordinates." } }, "type": "object", "description": "Detected entity location information.", "id": "GoogleCloudVisionV1p3beta1LocationInfo" }, "GoogleCloudVisionV1p2beta1ImageProperties": { "properties": { "dominantColors": { "$ref": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation", "description": "If present, dominant colors completed successfully." } }, "type": "object", "description": "Stores image properties, such as dominant colors.", "id": "GoogleCloudVisionV1p2beta1ImageProperties" }, "GoogleCloudVisionV1p1beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "id": "GoogleCloudVisionV1p1beta1BoundingPoly", "properties": { "vertices": { "items": { "$ref": "GoogleCloudVisionV1p1beta1Vertex" }, "type": "array", "description": "The bounding polygon vertices." }, "normalizedVertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1NormalizedVertex" }, "description": "The bounding polygon normalized vertices." } }, "type": "object" }, "GoogleCloudVisionV1p3beta1OperationMetadata": { "description": "Contains metadata for the BatchAnnotateImages operation.", "id": "GoogleCloudVisionV1p3beta1OperationMetadata", "properties": { "state": { "description": "Current state of the batch operation.", "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" }, "createTime": { "type": "string", "description": "The time when the batch request was received.", "format": "google-datetime" }, "updateTime": { "type": "string", "description": "The time when the operation result was last updated.", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": { "description": "Additional information detected on the structural component.", "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "properties": { "detectedLanguages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence." }, "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse", "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": { "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" }, "totalPages": { "description": "This field gives the total number of pages in the file.", "format": "int32", "type": "integer" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p2beta1InputConfig" }, "error": { "$ref": "Status", "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case." } } }, "GoogleCloudVisionV1p1beta1FaceAnnotation": { "description": "A face annotation object contains the results of face detection.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotation", "properties": { "angerLikelihood": { "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." ], "description": "Anger likelihood." }, "landmarkingConfidence": { "type": "number", "description": "Face landmarking confidence. Range [0, 1].", "format": "float" }, "headwearLikelihood": { "description": "Headwear 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" }, "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].", "format": "float", "type": "number" }, "underExposedLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "surpriseLikelihood": { "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." ], "description": "Surprise likelihood." }, "fdBoundingPoly": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", "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." }, "panAngle": { "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].", "format": "float" }, "joyLikelihood": { "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." ], "description": "Joy likelihood." }, "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" }, "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": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "blurredLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string", "description": "Blurred likelihood.", "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": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" } }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "format": "float", "type": "number" }, "sorrowLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "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." ] } }, "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { "properties": { "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p1beta1InputConfig" }, "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": { "description": "This field gives the total number of pages in the file.", "format": "int32", "type": "integer" }, "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." } }, "type": "object", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "description": "Y coordinate.", "format": "float", "type": "number" } }, "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.", "id": "GoogleCloudVisionV1p4beta1NormalizedVertex" }, "GoogleCloudVisionV1p3beta1ColorInfo": { "type": "object", "properties": { "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" }, "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" } }, "id": "GoogleCloudVisionV1p3beta1ColorInfo", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image." }, "Paragraph": { "properties": { "property": { "description": "Additional information detected for the paragraph.", "$ref": "TextProperty" }, "words": { "type": "array", "items": { "$ref": "Word" }, "description": "List of all words in this paragraph." }, "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)." }, "confidence": { "type": "number", "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float" } }, "type": "object", "description": "Structural unit of text representing a number of words in certain order.", "id": "Paragraph" }, "GoogleCloudVisionV1p4beta1CropHint": { "id": "GoogleCloudVisionV1p4beta1CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object", "properties": { "boundingPoly": { "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "confidence": { "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float" }, "importanceFraction": { "type": "number", "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float" } } }, "GoogleCloudVisionV1p1beta1DominantColorsAnnotation": { "type": "object", "properties": { "colors": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ColorInfo" }, "description": "RGB color values with their score and pixel fraction." } }, "id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation", "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p3beta1WebDetectionWebLabel": { "id": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel", "description": "Label to provide extra metadata for the web detection.", "type": "object", "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." } } }, "GoogleCloudVisionV1p1beta1OperationMetadata": { "description": "Contains metadata for the BatchAnnotateImages operation.", "id": "GoogleCloudVisionV1p1beta1OperationMetadata", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "type": "string", "description": "Current state of the batch operation.", "enumDescriptions": [ "Invalid.", "Request is received.", "Request is actively being processed.", "The batch processing is done.", "The batch processing was cancelled." ] }, "createTime": { "description": "The time when the batch request was received.", "format": "google-datetime", "type": "string" }, "updateTime": { "description": "The time when the operation result was last updated.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p3beta1InputConfig": { "type": "object", "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": { "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.", "format": "byte" } }, "id": "GoogleCloudVisionV1p3beta1InputConfig", "description": "The desired input location and metadata." }, "GoogleCloudVisionV1p1beta1ColorInfo": { "properties": { "pixelFraction": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" }, "color": { "$ref": "Color", "description": "RGB components of the color." }, "score": { "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float", "type": "number" } }, "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "id": "GoogleCloudVisionV1p1beta1ColorInfo" }, "GoogleCloudVisionV1p1beta1Product": { "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" }, "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." }, "productLabels": { "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": "array" }, "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" } }, "type": "object", "description": "A Product contains ReferenceImages.", "id": "GoogleCloudVisionV1p1beta1Product" }, "GoogleCloudVisionV1p3beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "id": "GoogleCloudVisionV1p3beta1BoundingPoly", "properties": { "vertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Vertex" }, "description": "The bounding polygon vertices." }, "normalizedVertices": { "items": { "$ref": "GoogleCloudVisionV1p3beta1NormalizedVertex" }, "type": "array", "description": "The bounding polygon normalized vertices." } }, "type": "object" }, "GoogleCloudVisionV1p2beta1OutputConfig": { "description": "The desired output location and metadata.", "id": "GoogleCloudVisionV1p2beta1OutputConfig", "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." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak": { "description": "Detected start or end of a structural component.", "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak", "properties": { "type": { "type": "string", "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." ], "description": "Detected break type." }, "isPrefix": { "type": "boolean", "description": "True if break prepends the element." } }, "type": "object" }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse": { "type": "object", "properties": { "responses": { "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" }, "type": "array", "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "description": "Response to an async batch file annotation request." }, "GcsDestination": { "id": "GcsDestination", "description": "The Google Cloud Storage location where the output will be written to.", "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." } } }, "ObjectAnnotation": { "type": "object", "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" } }, "id": "ObjectAnnotation", "description": "Prediction for what the object in the bounding box is." }, "GoogleCloudVisionV1p4beta1WebDetectionWebImage": { "description": "Metadata for online images.", "id": "GoogleCloudVisionV1p4beta1WebDetectionWebImage", "properties": { "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" }, "url": { "description": "The result image URL.", "type": "string" } }, "type": "object" }, "GoogleCloudVisionV1p2beta1Product": { "type": "object", "properties": { "description": { "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.", "type": "string" }, "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" }, "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": { "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": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, "type": "array" } }, "id": "GoogleCloudVisionV1p2beta1Product", "description": "A Product contains ReferenceImages." }, "GoogleCloudVisionV1p4beta1Paragraph": { "type": "object", "properties": { "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" }, "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" }, "property": { "description": "Additional information detected for the paragraph.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "words": { "items": { "$ref": "GoogleCloudVisionV1p4beta1Word" }, "type": "array", "description": "List of all words in this paragraph." } }, "id": "GoogleCloudVisionV1p4beta1Paragraph", "description": "Structural unit of text representing a number of words in certain order." }, "GoogleCloudVisionV1p2beta1OperationMetadata": { "id": "GoogleCloudVisionV1p2beta1OperationMetadata", "description": "Contains metadata for the BatchAnnotateImages operation.", "type": "object", "properties": { "state": { "description": "Current state of the batch operation.", "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" }, "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" } } }, "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation": { "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "description": "Prediction for what the object in the bounding box is.", "type": "object", "properties": { "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" }, "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" } } }, "Page": { "id": "Page", "description": "Detected page from OCR.", "type": "object", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "property": { "$ref": "TextProperty", "description": "Additional information detected on the page." }, "blocks": { "items": { "$ref": "Block" }, "type": "array", "description": "List of blocks of text, images etc on this page." }, "width": { "type": "integer", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "height": { "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" } } }, "GoogleCloudVisionV1p3beta1Vertex": { "id": "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": { "type": "integer", "description": "X coordinate.", "format": "int32" }, "y": { "type": "integer", "description": "Y coordinate.", "format": "int32" } } }, "GoogleCloudVisionV1p3beta1ProductSearchResultsResult": { "type": "object", "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p3beta1Product" }, "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" }, "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" } }, "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult", "description": "Information about a product." }, "CropHint": { "id": "CropHint", "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object", "properties": { "boundingPoly": { "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.", "$ref": "BoundingPoly" }, "confidence": { "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float" }, "importanceFraction": { "type": "number", "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float" } } }, "GoogleCloudVisionV1p2beta1ImageSource": { "description": "External image source (Google Cloud Storage or web URL image location).", "id": "GoogleCloudVisionV1p2beta1ImageSource", "properties": { "gcsImageUri": { "type": "string", "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." }, "imageUri": { "type": "string", "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": "object" }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage", "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" } }, "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": { "type": "object", "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." ], "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ], "type": "string" } }, "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak", "description": "Detected start or end of a structural component." }, "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation": { "type": "object", "properties": { "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "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." } }, "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation", "description": "Prediction for what the object in the bounding box is." }, "GoogleCloudVisionV1p2beta1LatLongRect": { "type": "object", "properties": { "maxLatLng": { "description": "Max lat/long pair.", "$ref": "LatLng" }, "minLatLng": { "description": "Min lat/long pair.", "$ref": "LatLng" } }, "id": "GoogleCloudVisionV1p2beta1LatLongRect", "description": "Rectangle determined by min and max `LatLng` pairs." }, "GoogleCloudVisionV1p1beta1Vertex": { "type": "object", "properties": { "x": { "description": "X coordinate.", "format": "int32", "type": "integer" }, "y": { "type": "integer", "description": "Y coordinate.", "format": "int32" } }, "id": "GoogleCloudVisionV1p1beta1Vertex", "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p4beta1ColorInfo": { "id": "GoogleCloudVisionV1p4beta1ColorInfo", "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": { "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" }, "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" } } } }, "discoveryVersion": "v1", "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." } } } }, "servicePath": "", "ownerDomain": "google.com", "title": "Cloud Vision API", "version_module": true, "kind": "discovery#restDescription", "baseUrl": "https://vision.googleapis.com/", "basePath": "", "ownerName": "Google", "revision": "20260810", "rootUrl": "https://vision.googleapis.com/", "parameters": { "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "alt": { "default": "json", "location": "query", "description": "Data format for response.", "type": "string", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "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" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "type": "string", "description": "V1 error format.", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "prettyPrint": { "type": "boolean", "default": "true", "location": "query", "description": "Returns response with indentations and line breaks." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } }, "resources": { "files": { "methods": { "annotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "id": "vision.files.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "path": "v1p2beta1/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.", "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "flatPath": "v1p2beta1/files:annotate", "parameters": {}, "httpMethod": "POST", "parameterOrder": [] }, "asyncBatchAnnotate": { "id": "vision.files.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "path": "v1p2beta1/files:asyncBatchAnnotate", "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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "httpMethod": "POST", "parameterOrder": [], "flatPath": "v1p2beta1/files:asyncBatchAnnotate", "parameters": {}, "response": { "$ref": "Operation" } } } }, "images": { "methods": { "annotate": { "id": "vision.images.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "path": "v1p2beta1/images:annotate", "description": "Run image detection and annotation for a batch of images.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "flatPath": "v1p2beta1/images:annotate", "parameters": {}, "httpMethod": "POST", "parameterOrder": [], "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" } }, "asyncBatchAnnotate": { "httpMethod": "POST", "parameterOrder": [], "flatPath": "v1p2beta1/images:asyncBatchAnnotate", "parameters": {}, "response": { "$ref": "Operation" }, "path": "v1p2beta1/images:asyncBatchAnnotate", "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", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] } } }, "projects": { "resources": { "images": { "methods": { "annotate": { "path": "v1p2beta1/{+parent}/images:annotate", "description": "Run image detection and annotation for a batch of images.", "id": "vision.projects.images.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "flatPath": "v1p2beta1/projects/{projectsId}/images:annotate", "parameters": { "parent": { "required": true, "type": "string", "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" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" } }, "asyncBatchAnnotate": { "id": "vision.projects.images.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "path": "v1p2beta1/{+parent}/images:asyncBatchAnnotate", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1p2beta1/projects/{projectsId}/images:asyncBatchAnnotate", "parameters": { "parent": { "required": true, "type": "string", "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" } }, "response": { "$ref": "Operation" } } } }, "locations": { "resources": { "images": { "methods": { "annotate": { "path": "v1p2beta1/{+parent}/images:annotate", "description": "Run image detection and annotation for a batch of images.", "id": "vision.projects.locations.images.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/images:annotate", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "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, "type": "string" } }, "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateImagesResponse" } }, "asyncBatchAnnotate": { "id": "vision.projects.locations.images.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest" }, "path": "v1p2beta1/{+parent}/images:asyncBatchAnnotate", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "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, "type": "string" } }, "response": { "$ref": "Operation" } } } }, "files": { "methods": { "annotate": { "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:annotate", "parameters": { "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "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`." } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "id": "vision.projects.locations.files.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "path": "v1p2beta1/{+parent}/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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] }, "asyncBatchAnnotate": { "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "flatPath": "v1p2beta1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "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, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p2beta1/{+parent}/files:asyncBatchAnnotate", "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", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" } } } } } }, "files": { "methods": { "annotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p2beta1/{+parent}/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.", "id": "vision.projects.files.annotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest" }, "response": { "$ref": "GoogleCloudVisionV1p2beta1BatchAnnotateFilesResponse" }, "flatPath": "v1p2beta1/projects/{projectsId}/files:annotate", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "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, "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ] }, "asyncBatchAnnotate": { "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/[^/]+$", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "id": "vision.projects.files.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest" }, "path": "v1p2beta1/{+parent}/files:asyncBatchAnnotate", "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).", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] } } } } } }, "documentationLink": "https://cloud.google.com/vision/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "batchPath": "batch" }