{ "revision": "20260619", "version_module": true, "fullyEncodeReservedExpansion": true, "mtlsRootUrl": "https://vision.mtls.googleapis.com/", "rootUrl": "https://vision.googleapis.com/", "schemas": { "BoundingPoly": { "id": "BoundingPoly", "type": "object", "description": "A bounding polygon for the detected image annotation.", "properties": { "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "NormalizedVertex" } }, "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "Vertex" } } } }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 \u003c= x \u003c width` or `0 \u003c= y \u003c height`.", "properties": { "type": { "enum": [ "UNKNOWN_LANDMARK", "LEFT_EYE", "RIGHT_EYE", "LEFT_OF_LEFT_EYEBROW", "RIGHT_OF_LEFT_EYEBROW", "LEFT_OF_RIGHT_EYEBROW", "RIGHT_OF_RIGHT_EYEBROW", "MIDPOINT_BETWEEN_EYES", "NOSE_TIP", "UPPER_LIP", "LOWER_LIP", "MOUTH_LEFT", "MOUTH_RIGHT", "MOUTH_CENTER", "NOSE_BOTTOM_RIGHT", "NOSE_BOTTOM_LEFT", "NOSE_BOTTOM_CENTER", "LEFT_EYE_TOP_BOUNDARY", "LEFT_EYE_RIGHT_CORNER", "LEFT_EYE_BOTTOM_BOUNDARY", "LEFT_EYE_LEFT_CORNER", "RIGHT_EYE_TOP_BOUNDARY", "RIGHT_EYE_RIGHT_CORNER", "RIGHT_EYE_BOTTOM_BOUNDARY", "RIGHT_EYE_LEFT_CORNER", "LEFT_EYEBROW_UPPER_MIDPOINT", "RIGHT_EYEBROW_UPPER_MIDPOINT", "LEFT_EAR_TRAGION", "RIGHT_EAR_TRAGION", "LEFT_EYE_PUPIL", "RIGHT_EYE_PUPIL", "FOREHEAD_GLABELLA", "CHIN_GNATHION", "CHIN_LEFT_GONION", "CHIN_RIGHT_GONION", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "description": "Face landmark type.", "enumDescriptions": [ "Unknown face landmark detected. Should not be filled.", "Left eye.", "Right eye.", "Left of left eyebrow.", "Right of left eyebrow.", "Left of right eyebrow.", "Right of right eyebrow.", "Midpoint between eyes.", "Nose tip.", "Upper lip.", "Lower lip.", "Mouth left.", "Mouth right.", "Mouth center.", "Nose, bottom right.", "Nose, bottom left.", "Nose, bottom center.", "Left eye, top boundary.", "Left eye, right corner.", "Left eye, bottom boundary.", "Left eye, left corner.", "Right eye, top boundary.", "Right eye, right corner.", "Right eye, bottom boundary.", "Right eye, left corner.", "Left eyebrow, upper midpoint.", "Right eyebrow, upper midpoint.", "Left ear tragion.", "Right ear tragion.", "Left eye pupil.", "Right eye pupil.", "Forehead glabella.", "Chin gnathion.", "Chin left gonion.", "Chin right gonion.", "Left cheek center.", "Right cheek center." ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p2beta1Position" } }, "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "type": "object" }, "GoogleCloudVisionV1p4beta1BoundingPoly": { "type": "object", "id": "GoogleCloudVisionV1p4beta1BoundingPoly", "properties": { "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Vertex" } }, "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1NormalizedVertex" } } }, "description": "A bounding polygon for the detected image annotation." }, "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.", "properties": { "pages": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Page" } }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "id": "GoogleCloudVisionV1p3beta1TextAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetection": { "id": "GoogleCloudVisionV1p1beta1WebDetection", "type": "object", "description": "Relevant information for the image from the Internet.", "properties": { "bestGuessLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web." }, "webEntities": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity" }, "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": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops." }, "visuallySimilarImages": { "description": "The visually similar image results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" } } } }, "GoogleCloudVisionV1p4beta1WebDetectionWebImage": { "description": "Metadata for online images.", "properties": { "url": { "description": "The result image URL.", "type": "string" }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" } }, "id": "GoogleCloudVisionV1p4beta1WebDetectionWebImage", "type": "object" }, "GoogleCloudVisionV1p3beta1ProductSearchResultsResult": { "type": "object", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult", "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p3beta1Product" }, "score": { "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" }, "image": { "type": "string", "description": "The resource name of the image from the product that is the closest match to the query." } }, "description": "Information about a product." }, "GoogleCloudVisionV1p4beta1GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "properties": { "uri": { "type": "string", "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files." } }, "id": "GoogleCloudVisionV1p4beta1GcsDestination", "type": "object" }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse": { "description": "Response to an async batch file annotation request.", "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse" }, "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse", "type": "object" }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest": { "type": "object", "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest", "properties": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "type": "string" }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", "additionalProperties": { "type": "string" } }, "requests": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileRequest" }, "description": "Required. Individual async file annotation requests for this batch." } }, "description": "Multiple async file annotation requests are batched into a single service call." }, "GoogleCloudVisionV1p1beta1Symbol": { "properties": { "text": { "description": "The actual UTF-8 representation of the symbol.", "type": "string" }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "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" } }, "description": "A single symbol representation.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Symbol" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "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." }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "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`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } }, "id": "Operation", "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "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" } }, "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage", "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateFileRequest": { "id": "GoogleCloudVisionV1p1beta1AnnotateFileRequest", "type": "object", "description": "A request to annotate one single file, e.g. a PDF, TIFF or GIF file.", "properties": { "inputConfig": { "description": "Required. Information about the input file.", "$ref": "GoogleCloudVisionV1p1beta1InputConfig" }, "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p1beta1ImageContext" }, "features": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Feature" }, "description": "Required. Requested features." }, "pages": { "description": "Pages of the file to perform image annotation. Pages starts from 1, we assume the first page of the file is page 1. At most 5 pages are supported per request. Pages can be negative. Page 1 means the first page. Page 2 means the second page. Page -1 means the last page. Page -2 means the second to the last page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If this field is empty, by default the service performs image annotation for the first 5 pages of the file.", "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "ImportProductSetsResponse": { "properties": { "referenceImages": { "type": "array", "items": { "$ref": "ReferenceImage" }, "description": "The list of reference_images that are imported successfully." }, "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." } }, "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "type": "object", "id": "ImportProductSetsResponse" }, "GoogleCloudVisionV1p2beta1ImageProperties": { "id": "GoogleCloudVisionV1p2beta1ImageProperties", "type": "object", "description": "Stores image properties, such as dominant colors.", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation" } } }, "TextProperty": { "description": "Additional information detected on the structural component.", "properties": { "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "DetectedLanguage" } }, "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "DetectedBreak" } }, "id": "TextProperty", "type": "object" }, "Paragraph": { "description": "Structural unit of text representing a number of words in certain order.", "properties": { "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the paragraph.", "$ref": "TextProperty" }, "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": "BoundingPoly" }, "words": { "type": "array", "items": { "$ref": "Word" }, "description": "List of all words in this paragraph." } }, "id": "Paragraph", "type": "object" }, "GoogleCloudVisionV1p3beta1ProductKeyValue": { "properties": { "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, "description": "A product label represented as a key-value pair.", "type": "object", "id": "GoogleCloudVisionV1p3beta1ProductKeyValue" }, "GoogleCloudVisionV1p1beta1TextDetectionParams": { "description": "Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.", "properties": { "enableTextDetectionConfidenceScore": { "type": "boolean", "description": "By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence score for TEXT_DETECTION as well." }, "advancedOcrOptions": { "description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudVisionV1p1beta1TextDetectionParams", "type": "object" }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "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": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage", "type": "object" }, "GoogleCloudVisionV1p2beta1BoundingPoly": { "id": "GoogleCloudVisionV1p2beta1BoundingPoly", "type": "object", "description": "A bounding polygon for the detected image annotation.", "properties": { "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1NormalizedVertex" } }, "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Vertex" } } } }, "Vertex": { "type": "object", "id": "Vertex", "properties": { "x": { "type": "integer", "description": "X coordinate.", "format": "int32" }, "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "WebImage": { "id": "WebImage", "type": "object", "description": "Metadata for online images.", "properties": { "url": { "description": "The result image URL.", "type": "string" }, "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p3beta1Property": { "type": "object", "id": "GoogleCloudVisionV1p3beta1Property", "properties": { "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" }, "name": { "description": "Name of the property.", "type": "string" }, "value": { "type": "string", "description": "Value of the property." } }, "description": "A `Property` consists of a user-supplied name/value pair." }, "GoogleCloudVisionV1p3beta1CropHintsAnnotation": { "id": "GoogleCloudVisionV1p3beta1CropHintsAnnotation", "type": "object", "description": "Set of crop hints that are used to generate new crops when serving images.", "properties": { "cropHints": { "description": "Crop hint results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1CropHint" } } } }, "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation": { "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation", "type": "object", "description": "Prediction for what the object in the bounding box is.", "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": { "description": "Object name, expressed in its `language_code` language.", "type": "string" } } }, "GcsSource": { "properties": { "uri": { "type": "string", "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported." } }, "description": "The Google Cloud Storage location where the input will be read from.", "type": "object", "id": "GcsSource" }, "GoogleCloudVisionV1p1beta1DominantColorsAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation", "properties": { "colors": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ColorInfo" }, "description": "RGB color values with their score and pixel fraction." } }, "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p1beta1FaceAnnotation": { "description": "A face annotation object contains the results of face detection.", "properties": { "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" }, "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" }, "sorrowLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Headwear likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "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" }, "surpriseLikelihood": { "type": "string", "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "landmarks": { "description": "Detected face landmarks.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" } }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "joyLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Joy likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "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" ], "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "blurredLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" } }, "id": "GoogleCloudVisionV1p1beta1FaceAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1LocationInfo": { "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } }, "description": "Detected entity location information.", "type": "object", "id": "GoogleCloudVisionV1p1beta1LocationInfo" }, "GoogleCloudVisionV1p4beta1Celebrity": { "id": "GoogleCloudVisionV1p4beta1Celebrity", "type": "object", "description": "A Celebrity is a group of Faces with an identity.", "properties": { "name": { "type": "string", "description": "The resource name of the preloaded Celebrity. Has the format `builtin/{mid}`." }, "displayName": { "description": "The Celebrity's display name.", "type": "string" }, "description": { "description": "The Celebrity's description.", "type": "string" } } }, "GoogleCloudVisionV1p4beta1ImageProperties": { "description": "Stores image properties, such as dominant colors.", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation" } }, "id": "GoogleCloudVisionV1p4beta1ImageProperties", "type": "object" }, "GoogleCloudVisionV1p2beta1Block": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Block", "properties": { "blockType": { "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "type": "string" }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "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).", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Paragraph" } }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" } }, "description": "Logical element on the page." }, "Status": { "type": "object", "id": "Status", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" } }, "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)." }, "GoogleCloudVisionV1p2beta1WebDetectionWebLabel": { "properties": { "label": { "type": "string", "description": "Label for extra metadata." }, "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" } }, "description": "Label to provide extra metadata for the web detection.", "type": "object", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "GoogleCloudVisionV1p4beta1EntityAnnotation": { "properties": { "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "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" } }, "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", "type": "number" }, "properties": { "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Property" } }, "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" }, "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "locale": { "type": "string", "description": "The language code for the locale in which the entity textual `description` is expressed." }, "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, "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" } }, "description": "Set of detected entity features.", "type": "object", "id": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "GoogleCloudVisionV1p1beta1Image": { "properties": { "content": { "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": "string" }, "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": "GoogleCloudVisionV1p1beta1ImageSource" } }, "description": "Client image to perform Google Cloud Vision API tasks over.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Image" }, "GoogleCloudVisionV1p2beta1GcsDestination": { "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." } }, "description": "The Google Cloud Storage location where the output will be written to.", "type": "object", "id": "GoogleCloudVisionV1p2beta1GcsDestination" }, "Product": { "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": { "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" }, "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" }, "productLabels": { "type": "array", "items": { "$ref": "KeyValue" }, "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." } }, "description": "A Product contains ReferenceImages.", "type": "object", "id": "Product" }, "GoogleCloudVisionV1p1beta1WebDetectionWebPage": { "description": "Metadata for web pages.", "properties": { "url": { "type": "string", "description": "The result web page URL." }, "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float", "type": "number" }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." }, "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image." }, "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." } }, "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", "type": "object" }, "GoogleCloudVisionV1p3beta1AnnotateImageResponse": { "description": "Response to an image annotation request.", "properties": { "landmarkAnnotations": { "description": "If present, landmark detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" } }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p3beta1ImageProperties" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResults" }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation" }, "faceAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotation" }, "description": "If present, face detection has completed successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" } }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation" } }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext" }, "localizedObjectAnnotations": { "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation" } }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotation" }, "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" }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1WebDetection" }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation" } }, "id": "GoogleCloudVisionV1p3beta1AnnotateImageResponse", "type": "object" }, "GoogleCloudVisionV1p4beta1NormalizedVertex": { "id": "GoogleCloudVisionV1p4beta1NormalizedVertex", "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.", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } } }, "GoogleCloudVisionV1p1beta1ColorInfo": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ColorInfo", "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": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" } }, "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image." }, "GoogleCloudVisionV1p4beta1AnnotateImageResponse": { "type": "object", "id": "GoogleCloudVisionV1p4beta1AnnotateImageResponse", "properties": { "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1WebDetection" }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation" }, "localizedObjectAnnotations": { "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation" } }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotation" }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" } }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext" }, "logoAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation" }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" } }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotation" } }, "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p4beta1ImageProperties" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResults" } }, "description": "Response to an image annotation request." }, "LocalizedObjectAnnotation": { "properties": { "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "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": "BoundingPoly" }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." } }, "description": "Set of detected objects with bounding boxes.", "type": "object", "id": "LocalizedObjectAnnotation" }, "WebEntity": { "id": "WebEntity", "type": "object", "description": "Entity deduced from similar images on the Internet.", "properties": { "entityId": { "type": "string", "description": "Opaque entity ID." }, "score": { "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float", "type": "number" }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" } } }, "GoogleCloudVisionV1p4beta1WebDetectionWebLabel": { "type": "object", "id": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel", "properties": { "label": { "type": "string", "description": "Label for extra metadata." }, "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" } }, "description": "Label to provide extra metadata for the web detection." }, "GoogleCloudVisionV1p4beta1OutputConfig": { "type": "object", "id": "GoogleCloudVisionV1p4beta1OutputConfig", "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p4beta1GcsDestination" }, "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" } }, "description": "The desired output location and metadata." }, "GoogleCloudVisionV1p1beta1ImageProperties": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ImageProperties", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation" } }, "description": "Stores image properties, such as dominant colors." }, "GoogleCloudVisionV1p3beta1AnnotateFileResponse": { "id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse", "type": "object", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse" }, "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set." }, "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": "GoogleCloudVisionV1p3beta1InputConfig" }, "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" } } }, "Block": { "type": "object", "id": "Block", "properties": { "confidence": { "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the block.", "$ref": "TextProperty" }, "boundingBox": { "description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "BoundingPoly" }, "blockType": { "type": "string", "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" ] }, "paragraphs": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "Paragraph" } } }, "description": "Logical element on the page." }, "GoogleCloudVisionV1p4beta1Product": { "properties": { "displayName": { "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.", "type": "string" }, "description": { "description": "User-provided metadata to be stored with this product. 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" }, "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." }, "productLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." } }, "description": "A Product contains ReferenceImages.", "type": "object", "id": "GoogleCloudVisionV1p4beta1Product" }, "GoogleCloudVisionV1p4beta1GcsSource": { "description": "The Google Cloud Storage location where the input will be read from.", "properties": { "uri": { "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.", "type": "string" } }, "id": "GoogleCloudVisionV1p4beta1GcsSource", "type": "object" }, "GoogleCloudVisionV1p1beta1CropHint": { "id": "GoogleCloudVisionV1p1beta1CropHint", "type": "object", "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" }, "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" } } }, "GoogleCloudVisionV1p3beta1Block": { "description": "Logical element on the page.", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" }, "blockType": { "type": "string", "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" ] }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "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": { "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Paragraph" } } }, "id": "GoogleCloudVisionV1p3beta1Block", "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateImageResponse": { "type": "object", "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse", "properties": { "faceAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation" }, "description": "If present, face detection has completed successfully." }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation" }, "textAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p1beta1ImageProperties" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResults" }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation" }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p1beta1WebDetection" }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "logoAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully." }, "localizedObjectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation" }, "labelAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext" } }, "description": "Response to an image annotation request." }, "GoogleCloudVisionV1p1beta1ImageSource": { "id": "GoogleCloudVisionV1p1beta1ImageSource", "type": "object", "description": "External image source (Google Cloud Storage or web URL image location).", "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." } } }, "OperationMetadata": { "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "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": { "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" } }, "description": "Contains metadata for the BatchAnnotateImages operation.", "type": "object", "id": "OperationMetadata" }, "GoogleCloudVisionV1p3beta1Word": { "type": "object", "id": "GoogleCloudVisionV1p3beta1Word", "properties": { "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" }, "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Symbol" } }, "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" } }, "description": "A word representation." }, "GoogleCloudVisionV1p1beta1WebDetectionParams": { "id": "GoogleCloudVisionV1p1beta1WebDetectionParams", "type": "object", "description": "Parameters for web detection request.", "properties": { "includeGeoResults": { "description": "This field has no effect on results.", "deprecated": true, "type": "boolean" } } }, "GoogleCloudVisionV1p2beta1EntityAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p2beta1EntityAnnotation", "properties": { "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": { "deprecated": true, "type": "number", "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float" }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", "type": "number" }, "properties": { "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Property" } }, "locations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocationInfo" }, "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks." }, "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" }, "locale": { "type": "string", "description": "The language code for the locale in which the entity textual `description` is expressed." }, "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" } }, "description": "Set of detected entity features." }, "GoogleCloudVisionV1p3beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "properties": { "normalizedVertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1NormalizedVertex" }, "description": "The bounding polygon normalized vertices." }, "vertices": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Vertex" }, "description": "The bounding polygon vertices." } }, "id": "GoogleCloudVisionV1p3beta1BoundingPoly", "type": "object" }, "LocationInfo": { "id": "LocationInfo", "type": "object", "description": "Detected entity location information.", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } } }, "GoogleCloudVisionV1p2beta1WebDetectionWebImage": { "description": "Metadata for online images.", "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" } }, "id": "GoogleCloudVisionV1p2beta1WebDetectionWebImage", "type": "object" }, "GoogleCloudVisionV1p4beta1InputConfig": { "type": "object", "id": "GoogleCloudVisionV1p4beta1InputConfig", "properties": { "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" }, "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p4beta1GcsSource" } }, "description": "The desired input location and metadata." }, "CropHintsAnnotation": { "type": "object", "id": "CropHintsAnnotation", "properties": { "cropHints": { "type": "array", "items": { "$ref": "CropHint" }, "description": "Crop hint results." } }, "description": "Set of crop hints that are used to generate new crops when serving images." }, "GoogleCloudVisionV1p4beta1Block": { "description": "Logical element on the page.", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" }, "paragraphs": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Paragraph" }, "description": "List of paragraphs in this block (if this blocks is of type text)." }, "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": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "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" } }, "id": "GoogleCloudVisionV1p4beta1Block", "type": "object" }, "GoogleCloudVisionV1p3beta1ReferenceImage": { "type": "object", "id": "GoogleCloudVisionV1p3beta1ReferenceImage", "properties": { "uri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`." }, "name": { "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "boundingPolys": { "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" } } }, "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes." }, "GoogleCloudVisionV1p4beta1WebDetectionWebPage": { "description": "Metadata for web pages.", "properties": { "url": { "type": "string", "description": "The result web page URL." }, "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float", "type": "number" }, "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image." }, "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." } }, "id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage", "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty": { "description": "Additional information detected on the structural component.", "properties": { "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak" }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage" } } }, "id": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebLabel": { "description": "Label to provide extra metadata for the web detection.", "properties": { "label": { "type": "string", "description": "Label for extra metadata." }, "languageCode": { "type": "string", "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." } }, "id": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel", "type": "object" }, "Symbol": { "id": "Symbol", "type": "object", "description": "A single symbol representation.", "properties": { "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "TextProperty" }, "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" } } }, "GoogleCloudVisionV1p1beta1ProductSearchResultsResult": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult", "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p1beta1Product" }, "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" }, "image": { "type": "string", "description": "The resource name of the image from the product that is the closest match to the query." } }, "description": "Information about a product." }, "GoogleCloudVisionV1p2beta1ImageAnnotationContext": { "properties": { "uri": { "type": "string", "description": "The URI of the file used to produce the image." }, "pageNumber": { "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" } }, "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", "id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext" }, "GoogleCloudVisionV1p4beta1Paragraph": { "id": "GoogleCloudVisionV1p4beta1Paragraph", "type": "object", "description": "Structural unit of text representing a number of words in certain order.", "properties": { "property": { "description": "Additional information detected for the paragraph.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Word" } }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p4beta1DominantColorsAnnotation": { "id": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation", "type": "object", "description": "Set of dominant colors and their corresponding scores.", "properties": { "colors": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ColorInfo" }, "description": "RGB color values with their score and pixel fraction." } } }, "AsyncBatchAnnotateFilesResponse": { "id": "AsyncBatchAnnotateFilesResponse", "type": "object", "description": "Response to an async batch file annotation request.", "properties": { "responses": { "type": "array", "items": { "$ref": "AsyncAnnotateFileResponse" }, "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } } }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": { "type": "object", "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak", "properties": { "isPrefix": { "type": "boolean", "description": "True if break prepends the element." }, "type": { "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ], "description": "Detected break type.", "enumDescriptions": [ "Unknown break label type.", "Regular space.", "Sure space (very wide).", "Line-wrapping break.", "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" } }, "description": "Detected start or end of a structural component." }, "GoogleCloudVisionV1p2beta1AnnotateFileResponse": { "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": "GoogleCloudVisionV1p2beta1AnnotateImageResponse" } }, "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p2beta1InputConfig" }, "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" } }, "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "type": "object", "id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse" }, "ImageAnnotationContext": { "id": "ImageAnnotationContext", "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.", "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" } } }, "GoogleCloudVisionV1p3beta1OperationMetadata": { "id": "GoogleCloudVisionV1p3beta1OperationMetadata", "type": "object", "description": "Contains metadata for the BatchAnnotateImages operation.", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "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": { "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" } } }, "GoogleCloudVisionV1p1beta1Position": { "type": "object", "id": "GoogleCloudVisionV1p1beta1Position", "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" } }, "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." }, "GoogleCloudVisionV1p2beta1OperationMetadata": { "id": "GoogleCloudVisionV1p2beta1OperationMetadata", "type": "object", "description": "Contains metadata for the BatchAnnotateImages operation.", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "DONE", "CANCELLED" ], "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": { "type": "string", "description": "The time when the operation result was last updated.", "format": "google-datetime" } } }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse": { "properties": { "outputConfig": { "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest.", "$ref": "GoogleCloudVisionV1p4beta1OutputConfig" } }, "description": "Response to an async batch image annotation request.", "type": "object", "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse" }, "GoogleCloudVisionV1p4beta1ColorInfo": { "id": "GoogleCloudVisionV1p4beta1ColorInfo", "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "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" } } }, "GoogleCloudVisionV1p1beta1NormalizedVertex": { "type": "object", "id": "GoogleCloudVisionV1p1beta1NormalizedVertex", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } }, "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." }, "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" } }, "description": "The desired output location and metadata.", "type": "object", "id": "OutputConfig" }, "GoogleCloudVisionV1p4beta1WebDetectionWebEntity": { "id": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity", "type": "object", "description": "Entity deduced from similar images on the Internet.", "properties": { "entityId": { "type": "string", "description": "Opaque entity ID." }, "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" } } }, "GoogleCloudVisionV1p3beta1ImageProperties": { "description": "Stores image properties, such as dominant colors.", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation" } }, "id": "GoogleCloudVisionV1p3beta1ImageProperties", "type": "object" }, "GoogleCloudVisionV1p2beta1DominantColorsAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation", "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ColorInfo" } } }, "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": { "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel", "type": "object", "description": "Label to provide extra metadata for the web detection.", "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." } } }, "GoogleCloudVisionV1p3beta1GcsSource": { "type": "object", "id": "GoogleCloudVisionV1p3beta1GcsSource", "properties": { "uri": { "type": "string", "description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported." } }, "description": "The Google Cloud Storage location where the input will be read from." }, "DetectedLanguage": { "description": "Detected language for a structural component.", "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", "type": "object" }, "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": { "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." }, "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" }, "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": "GoogleCloudVisionV1p3beta1ProductKeyValue" } } }, "description": "A Product contains ReferenceImages.", "type": "object", "id": "GoogleCloudVisionV1p3beta1Product" }, "Position": { "properties": { "z": { "type": "number", "description": "Z coordinate (or depth).", "format": "float" }, "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } }, "description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.", "type": "object", "id": "Position" }, "GoogleCloudVisionV1p1beta1TextAnnotation": { "properties": { "pages": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Page" } }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "type": "object", "id": "GoogleCloudVisionV1p1beta1TextAnnotation" }, "ColorInfo": { "id": "ColorInfo", "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "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": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak": { "properties": { "type": { "type": "string", "description": "Detected break type.", "enumDescriptions": [ "Unknown break label type.", "Regular space.", "Sure space (very wide).", "Line-wrapping break.", "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ] }, "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" } }, "description": "Detected start or end of a structural component.", "type": "object", "id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak" }, "SafeSearchAnnotation": { "type": "object", "id": "SafeSearchAnnotation", "properties": { "adult": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "medical": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this is a medical image.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "racy": { "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "spoof": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "violence": { "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] } }, "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)." }, "GoogleCloudVisionV1p1beta1LatLongRect": { "description": "Rectangle determined by min and max `LatLng` pairs.", "properties": { "minLatLng": { "description": "Min lat/long pair.", "$ref": "LatLng" }, "maxLatLng": { "description": "Max lat/long pair.", "$ref": "LatLng" } }, "id": "GoogleCloudVisionV1p1beta1LatLongRect", "type": "object" }, "Landmark": { "id": "Landmark", "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`.", "properties": { "type": { "enum": [ "UNKNOWN_LANDMARK", "LEFT_EYE", "RIGHT_EYE", "LEFT_OF_LEFT_EYEBROW", "RIGHT_OF_LEFT_EYEBROW", "LEFT_OF_RIGHT_EYEBROW", "RIGHT_OF_RIGHT_EYEBROW", "MIDPOINT_BETWEEN_EYES", "NOSE_TIP", "UPPER_LIP", "LOWER_LIP", "MOUTH_LEFT", "MOUTH_RIGHT", "MOUTH_CENTER", "NOSE_BOTTOM_RIGHT", "NOSE_BOTTOM_LEFT", "NOSE_BOTTOM_CENTER", "LEFT_EYE_TOP_BOUNDARY", "LEFT_EYE_RIGHT_CORNER", "LEFT_EYE_BOTTOM_BOUNDARY", "LEFT_EYE_LEFT_CORNER", "RIGHT_EYE_TOP_BOUNDARY", "RIGHT_EYE_RIGHT_CORNER", "RIGHT_EYE_BOTTOM_BOUNDARY", "RIGHT_EYE_LEFT_CORNER", "LEFT_EYEBROW_UPPER_MIDPOINT", "RIGHT_EYEBROW_UPPER_MIDPOINT", "LEFT_EAR_TRAGION", "RIGHT_EAR_TRAGION", "LEFT_EYE_PUPIL", "RIGHT_EYE_PUPIL", "FOREHEAD_GLABELLA", "CHIN_GNATHION", "CHIN_LEFT_GONION", "CHIN_RIGHT_GONION", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "description": "Face landmark type.", "enumDescriptions": [ "Unknown face landmark detected. Should not be filled.", "Left eye.", "Right eye.", "Left of left eyebrow.", "Right of left eyebrow.", "Left of right eyebrow.", "Right of right eyebrow.", "Midpoint between eyes.", "Nose tip.", "Upper lip.", "Lower lip.", "Mouth left.", "Mouth right.", "Mouth center.", "Nose, bottom right.", "Nose, bottom left.", "Nose, bottom center.", "Left eye, top boundary.", "Left eye, right corner.", "Left eye, bottom boundary.", "Left eye, left corner.", "Right eye, top boundary.", "Right eye, right corner.", "Right eye, bottom boundary.", "Right eye, left corner.", "Left eyebrow, upper midpoint.", "Right eyebrow, upper midpoint.", "Left ear tragion.", "Right ear tragion.", "Left eye pupil.", "Right eye pupil.", "Forehead glabella.", "Chin gnathion.", "Chin left gonion.", "Chin right gonion.", "Left cheek center.", "Right cheek center." ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "Position" } } }, "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation": { "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": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "description": "Prediction for what the object in the bounding box is.", "type": "object", "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { "type": "object", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "type": { "enum": [ "UNKNOWN_LANDMARK", "LEFT_EYE", "RIGHT_EYE", "LEFT_OF_LEFT_EYEBROW", "RIGHT_OF_LEFT_EYEBROW", "LEFT_OF_RIGHT_EYEBROW", "RIGHT_OF_RIGHT_EYEBROW", "MIDPOINT_BETWEEN_EYES", "NOSE_TIP", "UPPER_LIP", "LOWER_LIP", "MOUTH_LEFT", "MOUTH_RIGHT", "MOUTH_CENTER", "NOSE_BOTTOM_RIGHT", "NOSE_BOTTOM_LEFT", "NOSE_BOTTOM_CENTER", "LEFT_EYE_TOP_BOUNDARY", "LEFT_EYE_RIGHT_CORNER", "LEFT_EYE_BOTTOM_BOUNDARY", "LEFT_EYE_LEFT_CORNER", "RIGHT_EYE_TOP_BOUNDARY", "RIGHT_EYE_RIGHT_CORNER", "RIGHT_EYE_BOTTOM_BOUNDARY", "RIGHT_EYE_LEFT_CORNER", "LEFT_EYEBROW_UPPER_MIDPOINT", "RIGHT_EYEBROW_UPPER_MIDPOINT", "LEFT_EAR_TRAGION", "RIGHT_EAR_TRAGION", "LEFT_EYE_PUPIL", "RIGHT_EYE_PUPIL", "FOREHEAD_GLABELLA", "CHIN_GNATHION", "CHIN_LEFT_GONION", "CHIN_RIGHT_GONION", "LEFT_CHEEK_CENTER", "RIGHT_CHEEK_CENTER" ], "description": "Face landmark type.", "enumDescriptions": [ "Unknown face landmark detected. Should not be filled.", "Left eye.", "Right eye.", "Left of left eyebrow.", "Right of left eyebrow.", "Left of right eyebrow.", "Right of right eyebrow.", "Midpoint between eyes.", "Nose tip.", "Upper lip.", "Lower lip.", "Mouth left.", "Mouth right.", "Mouth center.", "Nose, bottom right.", "Nose, bottom left.", "Nose, bottom center.", "Left eye, top boundary.", "Left eye, right corner.", "Left eye, bottom boundary.", "Left eye, left corner.", "Right eye, top boundary.", "Right eye, right corner.", "Right eye, bottom boundary.", "Right eye, left corner.", "Left eyebrow, upper midpoint.", "Right eyebrow, upper midpoint.", "Left ear tragion.", "Right ear tragion.", "Left eye pupil.", "Right eye pupil.", "Forehead glabella.", "Chin gnathion.", "Chin left gonion.", "Chin right gonion.", "Left cheek center.", "Right cheek center." ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p4beta1Position" } }, "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`." }, "GoogleCloudVisionV1p3beta1EntityAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p3beta1EntityAnnotation", "properties": { "score": { "type": "number", "description": "Overall score of the result. Range [0, 1].", "format": "float" }, "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." }, "locations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1LocationInfo" }, "description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks." }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "description": { "type": "string", "description": "Entity textual description, expressed in its `locale` language." }, "topicality": { "type": "number", "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" }, "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": { "deprecated": true, "type": "number", "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float" } }, "description": "Set of detected entity features." }, "GoogleCloudVisionV1p4beta1Word": { "type": "object", "id": "GoogleCloudVisionV1p4beta1Word", "properties": { "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" }, "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Symbol" } }, "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" } }, "description": "A word representation." }, "GoogleCloudVisionV1p1beta1EntityAnnotation": { "properties": { "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", "type": "number", "deprecated": true }, "topicality": { "type": "number", "description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].", "format": "float" }, "locale": { "description": "The language code for the locale in which the entity textual `description` is expressed.", "type": "string" }, "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": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "score": { "type": "number", "description": "Overall score of the result. Range [0, 1].", "format": "float" }, "properties": { "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Property" } }, "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" } } }, "description": "Set of detected entity features.", "type": "object", "id": "GoogleCloudVisionV1p1beta1EntityAnnotation" }, "GoogleCloudVisionV1p4beta1TextAnnotation": { "id": "GoogleCloudVisionV1p4beta1TextAnnotation", "type": "object", "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "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." } } }, "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": { "type": "object", "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult", "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" } }, "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation" } } }, "description": "Information about the products similar to a single product in a query image." }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { "type": "object", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "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" ], "description": "Face landmark type.", "enumDescriptions": [ "Unknown face landmark detected. Should not be filled.", "Left eye.", "Right eye.", "Left of left eyebrow.", "Right of left eyebrow.", "Left of right eyebrow.", "Right of right eyebrow.", "Midpoint between eyes.", "Nose tip.", "Upper lip.", "Lower lip.", "Mouth left.", "Mouth right.", "Mouth center.", "Nose, bottom right.", "Nose, bottom left.", "Nose, bottom center.", "Left eye, top boundary.", "Left eye, right corner.", "Left eye, bottom boundary.", "Left eye, left corner.", "Right eye, top boundary.", "Right eye, right corner.", "Right eye, bottom boundary.", "Right eye, left corner.", "Left eyebrow, upper midpoint.", "Right eyebrow, upper midpoint.", "Left ear tragion.", "Right ear tragion.", "Left eye pupil.", "Right eye pupil.", "Forehead glabella.", "Chin gnathion.", "Chin left gonion.", "Chin right gonion.", "Left cheek center.", "Right cheek center." ] }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p3beta1Position" } }, "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`." }, "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" } } }, "description": "Response to an async batch file annotation request.", "type": "object", "id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse" }, "GoogleCloudVisionV1p3beta1ImageAnnotationContext": { "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" } }, "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", "id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext" }, "GoogleCloudVisionV1p2beta1InputConfig": { "type": "object", "id": "GoogleCloudVisionV1p2beta1InputConfig", "properties": { "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": "GoogleCloudVisionV1p2beta1GcsSource" }, "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" } }, "description": "The desired input location and metadata." }, "GoogleCloudVisionV1p2beta1AnnotateImageResponse": { "id": "GoogleCloudVisionV1p2beta1AnnotateImageResponse", "type": "object", "description": "Response to an image annotation request.", "properties": { "landmarkAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "GoogleCloudVisionV1p2beta1ImageProperties" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResults" }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotation" } }, "textAnnotations": { "description": "If present, text (OCR) detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" } }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation" }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "logoAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" }, "description": "If present, logo detection has completed successfully." }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation" } }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation" } }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotation" }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation" }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "GoogleCloudVisionV1p2beta1WebDetection" } } }, "GroupedResult": { "description": "Information about the products similar to a single product in a query image.", "properties": { "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "BoundingPoly" }, "results": { "type": "array", "items": { "$ref": "Result" }, "description": "List of results, one for each product match." }, "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "type": "array", "items": { "$ref": "ObjectAnnotation" } } }, "id": "GroupedResult", "type": "object" }, "GoogleCloudVisionV1p1beta1Property": { "properties": { "value": { "description": "Value of the property.", "type": "string" }, "name": { "type": "string", "description": "Name of the property." }, "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" } }, "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Property" }, "GoogleCloudVisionV1p3beta1ProductSearchResults": { "type": "object", "id": "GoogleCloudVisionV1p3beta1ProductSearchResults", "properties": { "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult" } } }, "description": "Results for a product search request." }, "GoogleCloudVisionV1p2beta1Paragraph": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Paragraph", "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": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "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": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Word" } } }, "description": "Structural unit of text representing a number of words in certain order." }, "GoogleCloudVisionV1p4beta1CropHintsAnnotation": { "description": "Set of crop hints that are used to generate new crops when serving images.", "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1CropHint" }, "description": "Crop hint results." } }, "id": "GoogleCloudVisionV1p4beta1CropHintsAnnotation", "type": "object" }, "CropHint": { "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" }, "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" } }, "id": "CropHint", "type": "object" }, "WebLabel": { "description": "Label to provide extra metadata for the web detection.", "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." } }, "id": "WebLabel", "type": "object" }, "GoogleCloudVisionV1p1beta1AsyncAnnotateFileRequest": { "id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileRequest", "type": "object", "description": "An offline file annotation request.", "properties": { "inputConfig": { "description": "Required. Information about the input file.", "$ref": "GoogleCloudVisionV1p1beta1InputConfig" }, "imageContext": { "description": "Additional context that may accompany the image(s) in the file.", "$ref": "GoogleCloudVisionV1p1beta1ImageContext" }, "outputConfig": { "description": "Required. The desired output location and metadata (e.g. format).", "$ref": "GoogleCloudVisionV1p1beta1OutputConfig" }, "features": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Feature" }, "description": "Required. Requested features." } } }, "GoogleCloudVisionV1p4beta1WebDetection": { "id": "GoogleCloudVisionV1p4beta1WebDetection", "type": "object", "description": "Relevant information for the image from the Internet.", "properties": { "bestGuessLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web." }, "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": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" }, "description": "The visually similar image results." }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage" } }, "pagesWithMatchingImages": { "description": "Web pages containing the matching images from the Internet.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebPage" } }, "webEntities": { "description": "Deduced entities from similar images on the Internet.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity" } } } }, "GoogleCloudVisionV1p4beta1ProductKeyValue": { "properties": { "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "value": { "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, "description": "A product label represented as a key-value pair.", "type": "object", "id": "GoogleCloudVisionV1p4beta1ProductKeyValue" }, "GoogleCloudVisionV1p3beta1BatchOperationMetadata": { "id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata", "type": "object", "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.", "properties": { "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" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ], "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." ] } } }, "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest": { "properties": { "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", "additionalProperties": { "type": "string" } }, "requests": { "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateFileRequest" } }, "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`." } }, "description": "A list of requests to annotate files using the BatchAnnotateFiles API.", "type": "object", "id": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest" }, "FaceAnnotation": { "description": "A face annotation object contains the results of face detection.", "properties": { "surpriseLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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" }, "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" }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "format": "float", "type": "number" }, "sorrowLikelihood": { "type": "string", "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "headwearLikelihood": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "angerLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "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" }, "blurredLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "underExposedLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "BoundingPoly" }, "joyLikelihood": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "landmarks": { "type": "array", "items": { "$ref": "Landmark" }, "description": "Detected face landmarks." } }, "id": "FaceAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1Product": { "id": "GoogleCloudVisionV1p1beta1Product", "type": "object", "description": "A Product contains ReferenceImages.", "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." }, "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." }, "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" }, "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": "GoogleCloudVisionV1p1beta1ProductKeyValue" } } } }, "ReferenceImage": { "type": "object", "id": "ReferenceImage", "properties": { "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": "BoundingPoly" } }, "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." } }, "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes." }, "GoogleCloudVisionV1p4beta1ImageAnnotationContext": { "type": "object", "id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext", "properties": { "pageNumber": { "type": "integer", "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32" }, "uri": { "description": "The URI of the file used to produce the image.", "type": "string" } }, "description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image." }, "GoogleCloudVisionV1p1beta1Feature": { "type": "object", "id": "GoogleCloudVisionV1p1beta1Feature", "properties": { "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" ], "description": "The feature type.", "enumDescriptions": [ "Unspecified feature type.", "Run face detection.", "Run landmark detection.", "Run logo detection.", "Run label detection.", "Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.", "Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", "Run Safe Search to detect potentially unsafe or undesirable content.", "Compute a set of image properties, such as the image's dominant colors.", "Run crop hints.", "Run web detection.", "Run Product Search.", "Run localizer for object detection." ] }, "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" }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/rc\" for the latest release candidate." } }, "description": "The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple `Feature` objects can be specified in the `features` list." }, "GoogleCloudVisionV1p2beta1CropHint": { "properties": { "boundingPoly": { "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "confidence": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } }, "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object", "id": "GoogleCloudVisionV1p2beta1CropHint" }, "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": { "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult", "type": "object", "description": "Information about the products similar to a single product in a query image.", "properties": { "objectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation" }, "description": "List of generic predictions for the object in the bounding box." }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } } }, "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty": { "type": "object", "id": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty", "properties": { "detectedLanguages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence." }, "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak" } }, "description": "Additional information detected on the structural component." }, "GoogleCloudVisionV1p4beta1CropHint": { "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "importanceFraction": { "type": "number", "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float" }, "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": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p4beta1CropHint", "type": "object" }, "Page": { "description": "Detected page from OCR.", "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "TextProperty" }, "blocks": { "description": "List of blocks of text, images etc on this page.", "type": "array", "items": { "$ref": "Block" } }, "confidence": { "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float", "type": "number" }, "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" } }, "id": "Page", "type": "object" }, "GoogleCloudVisionV1p2beta1Property": { "properties": { "name": { "description": "Name of the property.", "type": "string" }, "value": { "description": "Value of the property.", "type": "string" }, "uint64Value": { "description": "Value of numeric properties.", "format": "uint64", "type": "string" } }, "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "id": "GoogleCloudVisionV1p2beta1Property" }, "GoogleCloudVisionV1p1beta1Vertex": { "type": "object", "id": "GoogleCloudVisionV1p1beta1Vertex", "properties": { "x": { "type": "integer", "description": "X coordinate.", "format": "int32" }, "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p3beta1SafeSearchAnnotation": { "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "properties": { "racy": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "spoof": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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": { "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "type": "string" }, "medical": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that this is a medical image.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] } }, "id": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation", "type": "object" }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage": { "type": "object", "id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage", "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" } }, "description": "Detected language for a structural component." }, "GoogleCloudVisionV1p1beta1ProductSearchResults": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ProductSearchResults", "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult" } }, "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": { "description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult" } } }, "description": "Results for a product search request." }, "GoogleCloudVisionV1p3beta1WebDetectionWebEntity": { "description": "Entity deduced from similar images on the Internet.", "properties": { "score": { "type": "number", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float" }, "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "entityId": { "description": "Opaque entity ID.", "type": "string" } }, "id": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity", "type": "object" }, "Color": { "id": "Color", "type": "object", "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(''); }; // ...", "properties": { "red": { "type": "number", "description": "The amount of red in the color as a value in the interval [0, 1].", "format": "float" }, "green": { "type": "number", "description": "The amount of green in the color as a value in the interval [0, 1].", "format": "float" }, "alpha": { "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", "format": "float", "type": "number" }, "blue": { "description": "The amount of blue in the color as a value in the interval [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p2beta1Symbol": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Symbol", "properties": { "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "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": "GoogleCloudVisionV1p2beta1BoundingPoly" } }, "description": "A single symbol representation." }, "GoogleCloudVisionV1p1beta1BoundingPoly": { "properties": { "normalizedVertices": { "description": "The bounding polygon normalized vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1NormalizedVertex" } }, "vertices": { "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Vertex" } } }, "description": "A bounding polygon for the detected image annotation.", "type": "object", "id": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "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`.", "properties": { "type": { "description": "Face landmark type.", "enumDescriptions": [ "Unknown face landmark detected. Should not be filled.", "Left eye.", "Right eye.", "Left of left eyebrow.", "Right of left eyebrow.", "Left of right eyebrow.", "Right of right eyebrow.", "Midpoint between eyes.", "Nose tip.", "Upper lip.", "Lower lip.", "Mouth left.", "Mouth right.", "Mouth center.", "Nose, bottom right.", "Nose, bottom left.", "Nose, bottom center.", "Left eye, top boundary.", "Left eye, right corner.", "Left eye, bottom boundary.", "Left eye, left corner.", "Right eye, top boundary.", "Right eye, right corner.", "Right eye, bottom boundary.", "Right eye, left corner.", "Left eyebrow, upper midpoint.", "Right eyebrow, upper midpoint.", "Left ear tragion.", "Right ear tragion.", "Left eye pupil.", "Right eye pupil.", "Forehead glabella.", "Chin gnathion.", "Chin left gonion.", "Chin right gonion.", "Left cheek center.", "Right cheek center." ], "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" ], "type": "string" }, "position": { "description": "Face landmark position.", "$ref": "GoogleCloudVisionV1p1beta1Position" } }, "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "type": "object" }, "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse": { "description": "The response for a single offline file annotation request.", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p2beta1OutputConfig" } }, "id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse", "type": "object" }, "GoogleCloudVisionV1p4beta1Vertex": { "type": "object", "id": "GoogleCloudVisionV1p4beta1Vertex", "properties": { "x": { "description": "X coordinate.", "format": "int32", "type": "integer" }, "y": { "type": "integer", "description": "Y coordinate.", "format": "int32" } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage": { "description": "Detected language for a structural component.", "properties": { "languageCode": { "type": "string", "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier." }, "confidence": { "description": "Confidence of detected language. Range [0, 1].", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage", "type": "object" }, "GoogleCloudVisionV1p2beta1Position": { "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.", "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" } }, "id": "GoogleCloudVisionV1p2beta1Position", "type": "object" }, "GoogleCloudVisionV1p3beta1LocationInfo": { "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } }, "description": "Detected entity location information.", "type": "object", "id": "GoogleCloudVisionV1p3beta1LocationInfo" }, "ProductSearchResults": { "description": "Results for a product search request.", "properties": { "results": { "type": "array", "items": { "$ref": "Result" }, "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": "GroupedResult" }, "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." } }, "id": "ProductSearchResults", "type": "object" }, "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse", "type": "object", "description": "A list of file annotation responses.", "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest." } } }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "properties": { "adult": { "type": "string", "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "medical": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "racy": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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" }, "violence": { "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] } }, "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)." }, "GoogleCloudVisionV1p3beta1ImportProductSetsResponse": { "type": "object", "id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse", "properties": { "referenceImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ReferenceImage" }, "description": "The list of reference_images that are imported successfully." }, "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." } }, "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." }, "GoogleCloudVisionV1p1beta1InputConfig": { "id": "GoogleCloudVisionV1p1beta1InputConfig", "type": "object", "description": "The desired input location and metadata.", "properties": { "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p1beta1GcsSource" }, "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": { "type": "string", "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported." } } }, "GoogleCloudVisionV1p1beta1CropHintsParams": { "description": "Parameters for crop hints annotation request.", "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.", "type": "array", "items": { "format": "float", "type": "number" } } }, "id": "GoogleCloudVisionV1p1beta1CropHintsParams", "type": "object" }, "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse", "type": "object", "description": "The response for a single offline file annotation request.", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p4beta1OutputConfig" } } }, "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation", "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." }, "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": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" }, "mid": { "description": "Object ID that should align with EntityAnnotation mid.", "type": "string" } }, "description": "Set of detected objects with bounding boxes." }, "TextAnnotation": { "type": "object", "id": "TextAnnotation", "properties": { "pages": { "type": "array", "items": { "$ref": "Page" }, "description": "List of pages detected by OCR." }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "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." }, "GoogleCloudVisionV1p2beta1ColorInfo": { "id": "GoogleCloudVisionV1p2beta1ColorInfo", "type": "object", "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "properties": { "color": { "description": "RGB components of the color.", "$ref": "Color" }, "score": { "type": "number", "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float" }, "pixelFraction": { "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p1beta1ImageContext": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ImageContext", "properties": { "latLongRect": { "description": "Not used.", "$ref": "GoogleCloudVisionV1p1beta1LatLongRect" }, "languageHints": { "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).", "type": "array", "items": { "type": "string" } }, "textDetectionParams": { "description": "Parameters for text detection and document text detection.", "$ref": "GoogleCloudVisionV1p1beta1TextDetectionParams" }, "cropHintsParams": { "description": "Parameters for crop hints annotation request.", "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams" }, "productSearchParams": { "description": "Parameters for product search.", "$ref": "GoogleCloudVisionV1p1beta1ProductSearchParams" }, "webDetectionParams": { "description": "Parameters for web detection.", "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams" } }, "description": "Image context and/or feature-specific parameters." }, "AnnotateImageResponse": { "id": "AnnotateImageResponse", "type": "object", "description": "Response to an image annotation request.", "properties": { "landmarkAnnotations": { "type": "array", "items": { "$ref": "EntityAnnotation" }, "description": "If present, landmark detection has completed successfully." }, "imagePropertiesAnnotation": { "description": "If present, image properties were extracted successfully.", "$ref": "ImageProperties" }, "productSearchResults": { "description": "If present, product search has completed successfully.", "$ref": "ProductSearchResults" }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", "items": { "$ref": "FaceAnnotation" } }, "safeSearchAnnotation": { "description": "If present, safe-search annotation has completed successfully.", "$ref": "SafeSearchAnnotation" }, "textAnnotations": { "type": "array", "items": { "$ref": "EntityAnnotation" }, "description": "If present, text (OCR) detection has completed successfully." }, "error": { "description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.", "$ref": "Status" }, "localizedObjectAnnotations": { "type": "array", "items": { "$ref": "LocalizedObjectAnnotation" }, "description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score." }, "fullTextAnnotation": { "description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.", "$ref": "TextAnnotation" }, "labelAnnotations": { "type": "array", "items": { "$ref": "EntityAnnotation" }, "description": "If present, label detection has completed successfully." }, "context": { "description": "If present, contextual information is needed to understand where this image comes from.", "$ref": "ImageAnnotationContext" }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "type": "array", "items": { "$ref": "EntityAnnotation" } }, "cropHintsAnnotation": { "description": "If present, crop hints have completed successfully.", "$ref": "CropHintsAnnotation" }, "webDetection": { "description": "If present, web detection has completed successfully.", "$ref": "WebDetection" } } }, "GoogleCloudVisionV1p4beta1ReferenceImage": { "type": "object", "id": "GoogleCloudVisionV1p4beta1ReferenceImage", "properties": { "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)." }, "name": { "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.", "type": "string" }, "uri": { "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.", "type": "string" } }, "description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes." }, "WebPage": { "id": "WebPage", "type": "object", "description": "Metadata for web pages.", "properties": { "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "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" } }, "fullMatchingImages": { "type": "array", "items": { "$ref": "WebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image." }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." } } }, "EntityAnnotation": { "properties": { "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": { "deprecated": true, "type": "number", "description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].", "format": "float" }, "boundingPoly": { "description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.", "$ref": "BoundingPoly" }, "score": { "type": "number", "description": "Overall score of the result. Range [0, 1].", "format": "float" }, "properties": { "type": "array", "items": { "$ref": "Property" }, "description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity." }, "locations": { "type": "array", "items": { "$ref": "LocationInfo" }, "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." }, "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" }, "locale": { "type": "string", "description": "The language code for the locale in which the entity textual `description` is expressed." }, "description": { "description": "Entity textual description, expressed in its `locale` language.", "type": "string" } }, "description": "Set of detected entity features.", "type": "object", "id": "EntityAnnotation" }, "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse": { "id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse", "type": "object", "description": "The response for a single offline file annotation request.", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p1beta1OutputConfig" } } }, "DetectedBreak": { "id": "DetectedBreak", "type": "object", "description": "Detected start or end of a structural component.", "properties": { "isPrefix": { "type": "boolean", "description": "True if break prepends the element." }, "type": { "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ], "description": "Detected break type.", "enumDescriptions": [ "Unknown break label type.", "Regular space.", "Sure space (very wide).", "Line-wrapping break.", "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "type": "string" } } }, "GoogleCloudVisionV1p1beta1GcsSource": { "id": "GoogleCloudVisionV1p1beta1GcsSource", "type": "object", "description": "The Google Cloud Storage location where the input will be read from.", "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" } } }, "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": { "description": "Response to a batch image annotation request.", "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, "description": "Individual responses to image annotation requests within the batch." } }, "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse", "type": "object" }, "GoogleCloudVisionV1p3beta1WebDetectionWebImage": { "type": "object", "id": "GoogleCloudVisionV1p3beta1WebDetectionWebImage", "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the image.", "format": "float" } }, "description": "Metadata for online images." }, "GoogleCloudVisionV1p2beta1Vertex": { "properties": { "x": { "type": "integer", "description": "X coordinate.", "format": "int32" }, "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" } }, "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", "id": "GoogleCloudVisionV1p2beta1Vertex" }, "BatchOperationMetadata": { "properties": { "state": { "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." ], "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ] }, "submitTime": { "type": "string", "description": "The time when the batch request was submitted to the server.", "format": "google-datetime" }, "endTime": { "type": "string", "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime" } }, "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "type": "object", "id": "BatchOperationMetadata" }, "AnnotateFileResponse": { "properties": { "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." }, "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "InputConfig" }, "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" } }, "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "type": "object", "id": "AnnotateFileResponse" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation": { "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": { "type": "string", "description": "Object name, expressed in its `language_code` language." }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "description": "Prediction for what the object in the bounding box is.", "type": "object", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation" }, "GoogleCloudVisionV1p3beta1Position": { "type": "object", "id": "GoogleCloudVisionV1p3beta1Position", "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" } }, "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." }, "GoogleCloudVisionV1p4beta1ProductSearchResults": { "type": "object", "id": "GoogleCloudVisionV1p4beta1ProductSearchResults", "properties": { "results": { "description": "List of results, one for each product match.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult" } }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult" } } }, "description": "Results for a product search request." }, "GoogleCloudVisionV1p3beta1FaceAnnotation": { "description": "A face annotation object contains the results of face detection.", "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" }, "surpriseLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "angerLikelihood": { "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." ], "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" }, "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": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "detectionConfidence": { "type": "number", "description": "Detection confidence. Range [0, 1].", "format": "float" }, "sorrowLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "headwearLikelihood": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "rollAngle": { "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].", "format": "float", "type": "number" }, "fdBoundingPoly": { "description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "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" }, "blurredLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "underExposedLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Under-exposed likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "landmarks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks." } }, "id": "GoogleCloudVisionV1p3beta1FaceAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1ProductKeyValue": { "type": "object", "id": "GoogleCloudVisionV1p1beta1ProductKeyValue", "properties": { "value": { "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } }, "description": "A product label represented as a key-value pair." }, "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest": { "id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest", "type": "object", "description": "Request for async image annotation for a list of images.", "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageRequest" }, "description": "Required. Individual image annotation requests for this batch." }, "outputConfig": { "description": "Required. The desired output location and metadata (e.g. format).", "$ref": "GoogleCloudVisionV1p1beta1OutputConfig" }, "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" }, "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" } } }, "GoogleCloudVisionV1p4beta1AnnotateFileResponse": { "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": "GoogleCloudVisionV1p4beta1AnnotateImageResponse" } }, "totalPages": { "type": "integer", "description": "This field gives the total number of pages in the file.", "format": "int32" }, "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p4beta1InputConfig" }, "error": { "description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.", "$ref": "Status" } }, "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "type": "object", "id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse" }, "InputConfig": { "properties": { "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GcsSource" }, "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" } }, "description": "The desired input location and metadata.", "type": "object", "id": "InputConfig" }, "AsyncAnnotateFileResponse": { "description": "The response for a single offline file annotation request.", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "OutputConfig" } }, "id": "AsyncAnnotateFileResponse", "type": "object" }, "GoogleCloudVisionV1p2beta1CropHintsAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p2beta1CropHintsAnnotation", "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1CropHint" }, "description": "Crop hint results." } }, "description": "Set of crop hints that are used to generate new crops when serving images." }, "GoogleCloudVisionV1p4beta1BatchOperationMetadata": { "properties": { "submitTime": { "type": "string", "description": "The time when the batch request was submitted to the server.", "format": "google-datetime" }, "endTime": { "type": "string", "description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.", "format": "google-datetime" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROCESSING", "SUCCESSFUL", "FAILED", "CANCELLED" ], "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." ] } }, "description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", "type": "object", "id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata" }, "GoogleCloudVisionV1p3beta1CropHint": { "id": "GoogleCloudVisionV1p3beta1CropHint", "type": "object", "description": "Single crop hint that is used to generate a new crop when serving an image.", "properties": { "boundingPoly": { "description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "confidence": { "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original image.", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p2beta1GcsSource": { "id": "GoogleCloudVisionV1p2beta1GcsSource", "type": "object", "description": "The Google Cloud Storage location where the input will be read from.", "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." } } }, "GoogleCloudVisionV1p3beta1GcsDestination": { "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, "description": "The Google Cloud Storage location where the output will be written to.", "type": "object", "id": "GoogleCloudVisionV1p3beta1GcsDestination" }, "GoogleCloudVisionV1p1beta1CropHintsAnnotation": { "description": "Set of crop hints that are used to generate new crops when serving images.", "properties": { "cropHints": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1CropHint" }, "description": "Crop hint results." } }, "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", "type": "object" }, "GoogleCloudVisionV1p4beta1Symbol": { "type": "object", "id": "GoogleCloudVisionV1p4beta1Symbol", "properties": { "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" }, "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" } }, "description": "A single symbol representation." }, "GoogleCloudVisionV1p3beta1ColorInfo": { "properties": { "color": { "description": "RGB components of the color.", "$ref": "Color" }, "score": { "type": "number", "description": "Image-specific score for this color. Value in range [0, 1].", "format": "float" }, "pixelFraction": { "type": "number", "description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].", "format": "float" } }, "description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.", "type": "object", "id": "GoogleCloudVisionV1p3beta1ColorInfo" }, "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak": { "properties": { "type": { "type": "string", "description": "Detected break type.", "enumDescriptions": [ "Unknown break label type.", "Regular space.", "Sure space (very wide).", "Line-wrapping break.", "End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", "Line break that ends a paragraph." ], "enum": [ "UNKNOWN", "SPACE", "SURE_SPACE", "EOL_SURE_SPACE", "HYPHEN", "LINE_BREAK" ] }, "isPrefix": { "type": "boolean", "description": "True if break prepends the element." } }, "description": "Detected start or end of a structural component.", "type": "object", "id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak" }, "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation", "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": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" } }, "description": "Set of detected objects with bounding boxes." }, "GoogleCloudVisionV1p3beta1DominantColorsAnnotation": { "properties": { "colors": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ColorInfo" }, "description": "RGB color values with their score and pixel fraction." } }, "description": "Set of dominant colors and their corresponding scores.", "type": "object", "id": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation" }, "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": { "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult", "type": "object", "description": "Information about the products similar to a single product in a query image.", "properties": { "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "objectAnnotations": { "description": "List of generic predictions for the object in the bounding box.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation" } } } }, "GoogleCloudVisionV1p2beta1FaceAnnotation": { "properties": { "boundingPoly": { "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.", "$ref": "GoogleCloudVisionV1p2beta1BoundingPoly" }, "detectionConfidence": { "type": "number", "description": "Detection confidence. Range [0, 1].", "format": "float" }, "sorrowLikelihood": { "type": "string", "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Headwear likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" }, "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" }, "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "landmarks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks." }, "blurredLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "underExposedLikelihood": { "description": "Under-exposed 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": { "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" }, "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" }, "joyLikelihood": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Joy likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] } }, "description": "A face annotation object contains the results of face detection.", "type": "object", "id": "GoogleCloudVisionV1p2beta1FaceAnnotation" }, "GoogleCloudVisionV1p4beta1FaceRecognitionResult": { "properties": { "celebrity": { "description": "The Celebrity that this face was matched to.", "$ref": "GoogleCloudVisionV1p4beta1Celebrity" }, "confidence": { "description": "Recognition confidence. Range [0, 1].", "format": "float", "type": "number" } }, "description": "Information about a face's identity.", "type": "object", "id": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "GoogleCloudVisionV1p2beta1ProductSearchResultsResult": { "description": "Information about a product.", "properties": { "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p2beta1Product" }, "score": { "type": "number", "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float" }, "image": { "type": "string", "description": "The resource name of the image from the product that is the closest match to the query." } }, "id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult", "type": "object" }, "GoogleCloudVisionV1p2beta1ProductKeyValue": { "properties": { "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." } }, "description": "A product label represented as a key-value pair.", "type": "object", "id": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, "AsyncBatchAnnotateImagesResponse": { "type": "object", "id": "AsyncBatchAnnotateImagesResponse", "properties": { "outputConfig": { "description": "The output location and metadata from AsyncBatchAnnotateImagesRequest.", "$ref": "OutputConfig" } }, "description": "Response to an async batch image annotation request." }, "GoogleCloudVisionV1p4beta1ImportProductSetsResponse": { "description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.", "properties": { "referenceImages": { "description": "The list of reference_images that are imported successfully.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1ReferenceImage" } }, "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." } }, "id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse", "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": { "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity", "type": "object", "description": "Entity deduced from similar images on the Internet.", "properties": { "entityId": { "description": "Opaque entity ID.", "type": "string" }, "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" } } }, "GoogleCloudVisionV1p2beta1Word": { "id": "GoogleCloudVisionV1p2beta1Word", "type": "object", "description": "A word representation.", "properties": { "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Symbol" } } } }, "GoogleCloudVisionV1p3beta1Symbol": { "description": "A single symbol representation.", "properties": { "property": { "description": "Additional information detected for the symbol.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "boundingBox": { "description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "text": { "type": "string", "description": "The actual UTF-8 representation of the symbol." }, "confidence": { "description": "Confidence of the OCR results for the symbol. Range [0, 1].", "format": "float", "type": "number" } }, "id": "GoogleCloudVisionV1p3beta1Symbol", "type": "object" }, "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": { "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest", "type": "object", "description": "Multiple image annotation requests are batched into a single service call.", "properties": { "requests": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageRequest" }, "description": "Required. Individual image annotation requests for this batch." }, "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" } }, "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" } } }, "GoogleCloudVisionV1p2beta1Page": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Page", "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty" }, "blocks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Block" }, "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" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" } }, "description": "Detected page from OCR." }, "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation": { "description": "Prediction for what the object in the bounding box is.", "properties": { "score": { "type": "number", "description": "Score of the result. Range [0, 1].", "format": "float" }, "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." } }, "id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation", "type": "object" }, "GoogleCloudVisionV1p1beta1OperationMetadata": { "type": "object", "id": "GoogleCloudVisionV1p1beta1OperationMetadata", "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" } }, "description": "Contains metadata for the BatchAnnotateImages operation." }, "GoogleCloudVisionV1p2beta1NormalizedVertex": { "id": "GoogleCloudVisionV1p2beta1NormalizedVertex", "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.", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } } }, "GoogleCloudVisionV1p2beta1OutputConfig": { "id": "GoogleCloudVisionV1p2beta1OutputConfig", "type": "object", "description": "The desired output location and metadata.", "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p2beta1GcsDestination" }, "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" } } }, "GoogleCloudVisionV1p1beta1AnnotateFileResponse": { "id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse", "type": "object", "description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.", "properties": { "inputConfig": { "description": "Information about the file for which this response is generated.", "$ref": "GoogleCloudVisionV1p1beta1InputConfig" }, "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": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" }, "description": "Individual responses to images found within the file. This field will be empty if the `error` field is set." }, "totalPages": { "description": "This field gives the total number of pages in the file.", "format": "int32", "type": "integer" } } }, "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak": { "properties": { "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" }, "isPrefix": { "description": "True if break prepends the element.", "type": "boolean" } }, "description": "Detected start or end of a structural component.", "type": "object", "id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak" }, "GoogleCloudVisionV1p2beta1Product": { "type": "object", "id": "GoogleCloudVisionV1p2beta1Product", "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": { "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." }, "productLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductKeyValue" }, "description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet." }, "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." } }, "description": "A Product contains ReferenceImages." }, "GoogleCloudVisionV1p1beta1ImageAnnotationContext": { "properties": { "uri": { "description": "The URI of the file used to produce the image.", "type": "string" }, "pageNumber": { "description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.", "format": "int32", "type": "integer" } }, "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", "id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext" }, "GoogleCloudVisionV1p1beta1OutputConfig": { "id": "GoogleCloudVisionV1p1beta1OutputConfig", "type": "object", "description": "The desired output location and metadata.", "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p1beta1GcsDestination" }, "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" } } }, "GoogleCloudVisionV1p2beta1WebDetectionWebEntity": { "type": "object", "id": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity", "properties": { "score": { "type": "number", "description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.", "format": "float" }, "description": { "type": "string", "description": "Canonical description of the entity, in English." }, "entityId": { "type": "string", "description": "Opaque entity ID." } }, "description": "Entity deduced from similar images on the Internet." }, "GoogleCloudVisionV1p2beta1WebDetectionWebPage": { "id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage", "type": "object", "description": "Metadata for web pages.", "properties": { "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "description": "Fully matching images on the page. Can include resized copies of the query image." }, "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" } }, "pageTitle": { "type": "string", "description": "Title for the web page, may contain HTML markups." }, "score": { "type": "number", "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float" }, "url": { "description": "The result web page URL.", "type": "string" } } }, "GoogleCloudVisionV1p3beta1Page": { "properties": { "width": { "type": "integer", "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "height": { "type": "integer", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty" }, "blocks": { "description": "List of blocks of text, images etc on this page.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Block" } } }, "description": "Detected page from OCR.", "type": "object", "id": "GoogleCloudVisionV1p3beta1Page" }, "Result": { "id": "Result", "type": "object", "description": "Information about a product.", "properties": { "product": { "description": "The Product.", "$ref": "Product" }, "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" } } }, "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.", "properties": { "x": { "type": "number", "description": "X coordinate.", "format": "float" }, "y": { "description": "Y coordinate.", "format": "float", "type": "number" } }, "id": "NormalizedVertex", "type": "object" }, "GoogleCloudVisionV1p1beta1Paragraph": { "id": "GoogleCloudVisionV1p1beta1Paragraph", "type": "object", "description": "Structural unit of text representing a number of words in certain order.", "properties": { "property": { "description": "Additional information detected for the paragraph.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "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" }, "words": { "description": "List of all words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Word" } }, "confidence": { "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation", "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." }, "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": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" }, "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." } }, "description": "Set of detected objects with bounding boxes." }, "GcsDestination": { "description": "The Google Cloud Storage location where the output will be written to.", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, "id": "GcsDestination", "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotation": { "type": "object", "id": "GoogleCloudVisionV1p4beta1FaceAnnotation", "properties": { "sorrowLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Sorrow likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Headwear likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "boundingPoly": { "description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated.", "$ref": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "detectionConfidence": { "description": "Detection confidence. Range [0, 1].", "format": "float", "type": "number" }, "panAngle": { "description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].", "format": "float", "type": "number" }, "angerLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Anger likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "surpriseLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Surprise likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "tiltAngle": { "type": "number", "description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].", "format": "float" }, "landmarks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark" }, "description": "Detected face landmarks." }, "recognitionResult": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1FaceRecognitionResult" }, "description": "Additional recognition information. Only computed if image_context.face_recognition_params is provided, **and** a match is found to a Celebrity in the input CelebritySet. This field is sorted in order of decreasing confidence values." }, "landmarkingConfidence": { "description": "Face landmarking confidence. Range [0, 1].", "format": "float", "type": "number" }, "underExposedLikelihood": { "description": "Under-exposed 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" }, "blurredLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Blurred likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is 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": "GoogleCloudVisionV1p4beta1BoundingPoly" }, "joyLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Joy likelihood.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" } }, "description": "A face annotation object contains the results of face detection." }, "GoogleCloudVisionV1p1beta1ProductSearchParams": { "id": "GoogleCloudVisionV1p1beta1ProductSearchParams", "type": "object", "description": "Parameters for a product search request.", "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": { "type": "array", "items": { "type": "string" }, "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." }, "boundingPoly": { "description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } } }, "GoogleCloudVisionV1p3beta1OutputConfig": { "type": "object", "id": "GoogleCloudVisionV1p3beta1OutputConfig", "properties": { "gcsDestination": { "description": "The Google Cloud Storage location to write the output(s) to.", "$ref": "GoogleCloudVisionV1p3beta1GcsDestination" }, "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" } }, "description": "The desired output location and metadata." }, "LatLng": { "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.", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double", "type": "number" }, "longitude": { "type": "number", "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double" } }, "id": "LatLng", "type": "object" }, "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse": { "properties": { "outputConfig": { "description": "The output location and metadata from AsyncAnnotateFileRequest.", "$ref": "GoogleCloudVisionV1p3beta1OutputConfig" } }, "description": "The response for a single offline file annotation request.", "type": "object", "id": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse" }, "GoogleCloudVisionV1p3beta1NormalizedVertex": { "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.", "properties": { "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } }, "id": "GoogleCloudVisionV1p3beta1NormalizedVertex", "type": "object" }, "Property": { "properties": { "value": { "type": "string", "description": "Value of the property." }, "name": { "type": "string", "description": "Name of the property." }, "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" } }, "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "id": "Property" }, "GoogleCloudVisionV1p4beta1Page": { "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "blocks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1Block" }, "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" }, "confidence": { "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float", "type": "number" } }, "description": "Detected page from OCR.", "type": "object", "id": "GoogleCloudVisionV1p4beta1Page" }, "GoogleCloudVisionV1p1beta1AnnotateImageRequest": { "type": "object", "id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest", "properties": { "imageContext": { "description": "Additional context that may accompany the image.", "$ref": "GoogleCloudVisionV1p1beta1ImageContext" }, "image": { "description": "The image to be processed.", "$ref": "GoogleCloudVisionV1p1beta1Image" }, "features": { "description": "Requested features.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Feature" } } }, "description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information." }, "GoogleCloudVisionV1p3beta1Paragraph": { "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" }, "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" }, "words": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1Word" }, "description": "List of all words in this paragraph." } }, "description": "Structural unit of text representing a number of words in certain order.", "type": "object", "id": "GoogleCloudVisionV1p3beta1Paragraph" }, "GoogleCloudVisionV1p4beta1Position": { "id": "GoogleCloudVisionV1p4beta1Position", "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.", "properties": { "z": { "type": "number", "description": "Z coordinate (or depth).", "format": "float" }, "x": { "description": "X coordinate.", "format": "float", "type": "number" }, "y": { "type": "number", "description": "Y coordinate.", "format": "float" } } }, "BatchAnnotateFilesResponse": { "id": "BatchAnnotateFilesResponse", "type": "object", "description": "A list of file annotation responses.", "properties": { "responses": { "type": "array", "items": { "$ref": "AnnotateFileResponse" }, "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest." } } }, "GoogleCloudVisionV1p4beta1Property": { "description": "A `Property` consists of a user-supplied name/value pair.", "properties": { "uint64Value": { "type": "string", "description": "Value of numeric properties.", "format": "uint64" }, "name": { "type": "string", "description": "Name of the property." }, "value": { "description": "Value of the property.", "type": "string" } }, "id": "GoogleCloudVisionV1p4beta1Property", "type": "object" }, "GoogleCloudVisionV1p4beta1OperationMetadata": { "type": "object", "id": "GoogleCloudVisionV1p4beta1OperationMetadata", "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": { "type": "string", "description": "The time when the operation result was last updated.", "format": "google-datetime" } }, "description": "Contains metadata for the BatchAnnotateImages operation." }, "GoogleCloudVisionV1p2beta1SafeSearchAnnotation": { "properties": { "racy": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] }, "spoof": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "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": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "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" } }, "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", "id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation" }, "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": { "description": "Information about the products similar to a single product in a query image.", "properties": { "boundingPoly": { "description": "The bounding polygon around the product detected in the query image.", "$ref": "GoogleCloudVisionV1p3beta1BoundingPoly" }, "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "objectAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation" }, "description": "List of generic predictions for the object in the bounding box." } }, "id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult", "type": "object" }, "ObjectAnnotation": { "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": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" } }, "description": "Prediction for what the object in the bounding box is.", "type": "object", "id": "ObjectAnnotation" }, "GoogleCloudVisionV1p1beta1Block": { "id": "GoogleCloudVisionV1p1beta1Block", "type": "object", "description": "Logical element on the page.", "properties": { "confidence": { "type": "number", "description": "Confidence of the OCR results on the block. Range [0, 1].", "format": "float" }, "property": { "description": "Additional information detected for the block.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "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": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "blockType": { "enum": [ "UNKNOWN", "TEXT", "TABLE", "PICTURE", "RULER", "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", "enumDescriptions": [ "Unknown block type.", "Regular text block.", "Table block.", "Image block.", "Horizontal/vertical line box.", "Barcode block." ], "type": "string" }, "paragraphs": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Paragraph" }, "description": "List of paragraphs in this block (if this blocks is of type text)." } } }, "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse": { "properties": { "responses": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse" }, "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest." } }, "description": "Response to an async batch file annotation request.", "type": "object", "id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse" }, "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse": { "id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse", "type": "object", "description": "Response to an async batch file annotation request.", "properties": { "responses": { "description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse" } } } }, "KeyValue": { "id": "KeyValue", "type": "object", "description": "A product label represented as a key-value pair.", "properties": { "value": { "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" }, "key": { "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.", "type": "string" } } }, "GoogleCloudVisionV1p4beta1SafeSearchAnnotation": { "properties": { "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" }, "violence": { "type": "string", "description": "Likelihood that this image contains violent content. Violent content may include death, serious harm, or injury to individuals or groups of individuals.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "racy": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ], "type": "string" }, "medical": { "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." ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ] }, "adult": { "type": "string", "enum": [ "UNKNOWN", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY" ], "description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely.", "It is unlikely.", "It is possible.", "It is likely.", "It is very likely." ] } }, "description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).", "type": "object", "id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation" }, "GoogleCloudVisionV1p2beta1LocationInfo": { "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } }, "description": "Detected entity location information.", "type": "object", "id": "GoogleCloudVisionV1p2beta1LocationInfo" }, "GoogleCloudVisionV1p1beta1Word": { "id": "GoogleCloudVisionV1p1beta1Word", "type": "object", "description": "A word representation.", "properties": { "property": { "description": "Additional information detected for the word.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "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": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" } }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" } } }, "GoogleCloudVisionV1p2beta1WebDetection": { "id": "GoogleCloudVisionV1p2beta1WebDetection", "type": "object", "description": "Relevant information for the image from the Internet.", "properties": { "bestGuessLabels": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel" }, "description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web." }, "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" }, "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "pagesWithMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebPage" }, "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": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" } }, "visuallySimilarImages": { "description": "The visually similar image results.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage" } }, "webEntities": { "description": "Deduced entities from similar images on the Internet.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity" } } } }, "GoogleCloudVisionV1p2beta1ProductSearchResults": { "id": "GoogleCloudVisionV1p2beta1ProductSearchResults", "type": "object", "description": "Results for a product search request.", "properties": { "results": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult" }, "description": "List of results, one for each product match." }, "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.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult" } } } }, "GoogleCloudVisionV1p4beta1ProductSearchResultsResult": { "type": "object", "id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult", "properties": { "image": { "description": "The resource name of the image from the product that is the closest match to the query.", "type": "string" }, "product": { "description": "The Product.", "$ref": "GoogleCloudVisionV1p4beta1Product" }, "score": { "description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).", "format": "float", "type": "number" } }, "description": "Information about a product." }, "GoogleCloudVisionV1p1beta1WebDetectionWebImage": { "properties": { "url": { "type": "string", "description": "The result image URL." }, "score": { "description": "(Deprecated) Overall relevancy score for the image.", "format": "float", "type": "number" } }, "description": "Metadata for online images.", "type": "object", "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" }, "WebDetection": { "description": "Relevant information for the image from the Internet.", "properties": { "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": "WebLabel" } }, "webEntities": { "description": "Deduced entities from similar images on the Internet.", "type": "array", "items": { "$ref": "WebEntity" } }, "partialMatchingImages": { "type": "array", "items": { "$ref": "WebImage" }, "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": "WebImage" }, "description": "The visually similar image results." }, "fullMatchingImages": { "description": "Fully matching images from the Internet. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "WebImage" } }, "pagesWithMatchingImages": { "description": "Web pages containing the matching images from the Internet.", "type": "array", "items": { "$ref": "WebPage" } } }, "id": "WebDetection", "type": "object" }, "GoogleCloudVisionV1p1beta1Page": { "properties": { "property": { "description": "Additional information detected on the page.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "blocks": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Block" }, "description": "List of blocks of text, images etc on this page." }, "width": { "description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32", "type": "integer" }, "confidence": { "type": "number", "description": "Confidence of the OCR results on the page. Range [0, 1].", "format": "float" }, "height": { "type": "integer", "description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.", "format": "int32" } }, "description": "Detected page from OCR.", "type": "object", "id": "GoogleCloudVisionV1p1beta1Page" }, "GoogleCloudVisionV1p1beta1GcsDestination": { "type": "object", "id": "GoogleCloudVisionV1p1beta1GcsDestination", "properties": { "uri": { "description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.", "type": "string" } }, "description": "The Google Cloud Storage location where the output will be written to." }, "GoogleCloudVisionV1p3beta1WebDetection": { "properties": { "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" } }, "fullMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "description": "Fully matching images from the Internet. Can include resized copies of the query image." }, "pagesWithMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebPage" }, "description": "Web pages containing the matching images from the Internet." }, "partialMatchingImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops." }, "visuallySimilarImages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" }, "description": "The visually similar image results." }, "webEntities": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity" }, "description": "Deduced entities from similar images on the Internet." } }, "description": "Relevant information for the image from the Internet.", "type": "object", "id": "GoogleCloudVisionV1p3beta1WebDetection" }, "Word": { "properties": { "symbols": { "description": "List of symbols in the word. The order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "Symbol" } }, "property": { "description": "Additional information detected for the word.", "$ref": "TextProperty" }, "boundingBox": { "description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).", "$ref": "BoundingPoly" }, "confidence": { "description": "Confidence of the OCR results for the word. Range [0, 1].", "format": "float", "type": "number" } }, "description": "A word representation.", "type": "object", "id": "Word" }, "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse": { "properties": { "responses": { "description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1AnnotateFileResponse" } } }, "description": "A list of file annotation responses.", "type": "object", "id": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse" }, "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": { "properties": { "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak" }, "detectedLanguages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence." } }, "description": "Additional information detected on the structural component.", "type": "object", "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "DominantColorsAnnotation": { "type": "object", "id": "DominantColorsAnnotation", "properties": { "colors": { "description": "RGB color values with their score and pixel fraction.", "type": "array", "items": { "$ref": "ColorInfo" } } }, "description": "Set of dominant colors and their corresponding scores." }, "GoogleCloudVisionV1p3beta1WebDetectionWebPage": { "properties": { "pageTitle": { "description": "Title for the web page, may contain HTML markups.", "type": "string" }, "fullMatchingImages": { "description": "Fully matching images on the page. Can include resized copies of the query image.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" } }, "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": "GoogleCloudVisionV1p3beta1WebDetectionWebImage" } }, "url": { "description": "The result web page URL.", "type": "string" }, "score": { "description": "(Deprecated) Overall relevancy score for the web page.", "format": "float", "type": "number" } }, "description": "Metadata for web pages.", "type": "object", "id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage" }, "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty": { "properties": { "detectedBreak": { "description": "Detected start or end of a text segment.", "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak" }, "detectedLanguages": { "type": "array", "items": { "$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage" }, "description": "A list of detected languages together with confidence." } }, "description": "Additional information detected on the structural component.", "type": "object", "id": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty" }, "GoogleCloudVisionV1p4beta1LocationInfo": { "type": "object", "id": "GoogleCloudVisionV1p4beta1LocationInfo", "properties": { "latLng": { "description": "lat/long location coordinates.", "$ref": "LatLng" } }, "description": "Detected entity location information." }, "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation": { "description": "Set of detected objects with bounding boxes.", "properties": { "mid": { "type": "string", "description": "Object ID that should align with EntityAnnotation mid." }, "score": { "description": "Score of the result. Range [0, 1].", "format": "float", "type": "number" }, "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" }, "boundingPoly": { "description": "Image region to which this object belongs. This must be populated.", "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } }, "id": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation", "type": "object" }, "ImageProperties": { "type": "object", "id": "ImageProperties", "properties": { "dominantColors": { "description": "If present, dominant colors completed successfully.", "$ref": "DominantColorsAnnotation" } }, "description": "Stores image properties, such as dominant colors." }, "GoogleCloudVisionV1p2beta1TextAnnotation": { "properties": { "pages": { "description": "List of pages detected by OCR.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p2beta1Page" } }, "text": { "type": "string", "description": "UTF-8 text detected on the pages." } }, "description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.", "type": "object", "id": "GoogleCloudVisionV1p2beta1TextAnnotation" }, "GoogleCloudVisionV1p3beta1Vertex": { "type": "object", "id": "GoogleCloudVisionV1p3beta1Vertex", "properties": { "x": { "description": "X coordinate.", "format": "int32", "type": "integer" }, "y": { "description": "Y coordinate.", "format": "int32", "type": "integer" } }, "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image." }, "GoogleCloudVisionV1p3beta1InputConfig": { "description": "The desired input location and metadata.", "properties": { "gcsSource": { "description": "The Google Cloud Storage location to read the input from.", "$ref": "GoogleCloudVisionV1p3beta1GcsSource" }, "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": { "type": "string", "description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported." } }, "id": "GoogleCloudVisionV1p3beta1InputConfig", "type": "object" } }, "name": "vision", "discoveryVersion": "v1", "resources": { "images": { "methods": { "asyncBatchAnnotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/images:asyncBatchAnnotate", "flatPath": "v1p1beta1/images:asyncBatchAnnotate", "parameterOrder": [], "response": { "$ref": "Operation" }, "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "httpMethod": "POST", "parameters": {}, "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest" }, "id": "vision.images.asyncBatchAnnotate" }, "annotate": { "httpMethod": "POST", "parameters": {}, "description": "Run image detection and annotation for a batch of images.", "response": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" }, "id": "vision.images.annotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest" }, "path": "v1p1beta1/images:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "parameterOrder": [], "flatPath": "v1p1beta1/images:annotate" } } }, "files": { "methods": { "annotate": { "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest" }, "id": "vision.files.annotate", "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "response": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse" }, "httpMethod": "POST", "parameters": {}, "flatPath": "v1p1beta1/files:annotate", "parameterOrder": [], "path": "v1p1beta1/files:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] }, "asyncBatchAnnotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/files:asyncBatchAnnotate", "flatPath": "v1p1beta1/files:asyncBatchAnnotate", "parameterOrder": [], "response": { "$ref": "Operation" }, "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).", "httpMethod": "POST", "parameters": {}, "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest" }, "id": "vision.files.asyncBatchAnnotate" } } }, "projects": { "resources": { "locations": { "resources": { "files": { "methods": { "annotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/{+parent}/files:annotate", "parameterOrder": [ "parent" ], "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/files:annotate", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse" }, "description": "Service that performs image detection and annotation for a batch of files. Now only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.", "id": "vision.projects.locations.files.annotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest" } }, "asyncBatchAnnotate": { "parameterOrder": [ "parent" ], "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate", "path": "v1p1beta1/{+parent}/files:asyncBatchAnnotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "id": "vision.projects.locations.files.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "required": true, "type": "string" } }, "description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).", "response": { "$ref": "Operation" } } } }, "images": { "methods": { "annotate": { "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest" }, "id": "vision.projects.locations.images.annotate", "description": "Run image detection and annotation for a batch of images.", "response": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/images:annotate", "parameterOrder": [ "parent" ], "path": "v1p1beta1/{+parent}/images:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] }, "asyncBatchAnnotate": { "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "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`.", "location": "path", "required": true } }, "response": { "$ref": "Operation" }, "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "id": "vision.projects.locations.images.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/{+parent}/images:asyncBatchAnnotate", "parameterOrder": [ "parent" ], "flatPath": "v1p1beta1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate" } } } } }, "images": { "methods": { "asyncBatchAnnotate": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/{+parent}/images:asyncBatchAnnotate", "parameterOrder": [ "parent" ], "flatPath": "v1p1beta1/projects/{projectsId}/images:asyncBatchAnnotate", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.", "id": "vision.projects.images.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest" } }, "annotate": { "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest" }, "id": "vision.projects.images.annotate", "description": "Run image detection and annotation for a batch of images.", "response": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" }, "httpMethod": "POST", "parameters": { "parent": { "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+$" } }, "flatPath": "v1p1beta1/projects/{projectsId}/images:annotate", "parameterOrder": [ "parent" ], "path": "v1p1beta1/{+parent}/images:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ] } } }, "files": { "methods": { "asyncBatchAnnotate": { "id": "vision.projects.files.asyncBatchAnnotate", "request": { "$ref": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest" }, "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+$", "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`.", "location": "path", "required": true } }, "response": { "$ref": "Operation" }, "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).", "parameterOrder": [ "parent" ], "flatPath": "v1p1beta1/projects/{projectsId}/files:asyncBatchAnnotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "path": "v1p1beta1/{+parent}/files:asyncBatchAnnotate" }, "annotate": { "flatPath": "v1p1beta1/projects/{projectsId}/files:annotate", "parameterOrder": [ "parent" ], "path": "v1p1beta1/{+parent}/files:annotate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-vision" ], "request": { "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest" }, "id": "vision.projects.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": "GoogleCloudVisionV1p1beta1BatchAnnotateFilesResponse" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "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/[^/]+$" } } } } } } } }, "id": "vision:v1p1beta1", "parameters": { "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" }, "key": { "location": "query", "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.", "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "quotaUser": { "location": "query", "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.", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "location": "query", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string", "default": "json", "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response." }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" } }, "version": "v1p1beta1", "kind": "discovery#restDescription", "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." } } } }, "documentationLink": "https://cloud.google.com/vision/", "baseUrl": "https://vision.googleapis.com/", "title": "Cloud Vision API", "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", "ownerName": "Google", "protocol": "rest", "ownerDomain": "google.com", "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "canonicalName": "Vision", "servicePath": "", "basePath": "" }