Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / vision.v1.json
blob: 92efb1a707ef8ee392b2f6fdad86a3495fb42d6a [file] [log] [blame] [edit]
{
"ownerDomain": "google.com",
"schemas": {
"GoogleCloudVisionV1p2beta1FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"id": "GoogleCloudVisionV1p2beta1FaceAnnotation",
"properties": {
"sorrowLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Sorrow likelihood.",
"type": "string"
},
"panAngle": {
"format": "float",
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].",
"type": "number"
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated."
},
"angerLikelihood": {
"type": "string",
"description": "Anger likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"landmarkingConfidence": {
"format": "float",
"description": "Face landmarking confidence. Range [0, 1].",
"type": "number"
},
"headwearLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"description": "Headwear likelihood."
},
"landmarks": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark"
},
"type": "array",
"description": "Detected face landmarks."
},
"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"
},
"surpriseLikelihood": {
"description": "Surprise likelihood.",
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"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"
},
"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"
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
"type": "number",
"format": "float"
},
"joyLikelihood": {
"description": "Joy likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"blurredLikelihood": {
"description": "Blurred likelihood.",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string"
},
"underExposedLikelihood": {
"description": "Under-exposed likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
}
},
"type": "object"
},
"Paragraph": {
"id": "Paragraph",
"description": "Structural unit of text representing a number of words in certain order.",
"properties": {
"boundingBox": {
"$ref": "BoundingPoly",
"description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"words": {
"type": "array",
"description": "List of all words in this paragraph.",
"items": {
"$ref": "Word"
}
},
"confidence": {
"format": "float",
"description": "Confidence of the OCR results for the paragraph. Range [0, 1].",
"type": "number"
},
"property": {
"description": "Additional information detected for the paragraph.",
"$ref": "TextProperty"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"type": "object",
"properties": {
"code": {
"format": "int32",
"type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code."
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
},
"type": "array"
}
}
},
"GoogleCloudVisionV1p1beta1InputConfig": {
"type": "object",
"properties": {
"mimeType": {
"type": "string",
"description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported."
},
"gcsSource": {
"description": "The Google Cloud Storage location to read the input from.",
"$ref": "GoogleCloudVisionV1p1beta1GcsSource"
},
"content": {
"format": "byte",
"type": "string",
"description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests."
}
},
"id": "GoogleCloudVisionV1p1beta1InputConfig",
"description": "The desired input location and metadata."
},
"GoogleCloudVisionV1p4beta1FaceAnnotation": {
"type": "object",
"description": "A face annotation object contains the results of face detection.",
"id": "GoogleCloudVisionV1p4beta1FaceAnnotation",
"properties": {
"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."
},
"fdBoundingPoly": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix."
},
"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"
]
},
"tiltAngle": {
"type": "number",
"description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].",
"format": "float"
},
"joyLikelihood": {
"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": {
"format": "float",
"type": "number",
"description": "Face landmarking confidence. Range [0, 1]."
},
"detectionConfidence": {
"format": "float",
"description": "Detection confidence. Range [0, 1].",
"type": "number"
},
"panAngle": {
"type": "number",
"format": "float",
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]."
},
"headwearLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Headwear likelihood.",
"type": "string"
},
"rollAngle": {
"format": "float",
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].",
"type": "number"
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated."
},
"sorrowLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Sorrow likelihood."
},
"blurredLikelihood": {
"description": "Blurred likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"underExposedLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Under-exposed likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"angerLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Anger likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string"
},
"landmarks": {
"type": "array",
"description": "Detected face landmarks.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark"
}
}
}
},
"OperationMetadata": {
"id": "OperationMetadata",
"description": "Contains metadata for the BatchAnnotateImages operation.",
"type": "object",
"properties": {
"updateTime": {
"description": "The time when the operation result was last updated.",
"format": "google-datetime",
"type": "string"
},
"state": {
"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."
],
"type": "string"
},
"createTime": {
"format": "google-datetime",
"description": "The time when the batch request was received.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p2beta1ImageAnnotationContext": {
"properties": {
"pageNumber": {
"type": "integer",
"format": "int32",
"description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image."
},
"uri": {
"description": "The URI of the file used to produce the image.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1ImageAnnotationContext",
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image."
},
"BatchAnnotateImagesResponse": {
"type": "object",
"description": "Response to a batch image annotation request.",
"properties": {
"responses": {
"type": "array",
"items": {
"$ref": "AnnotateImageResponse"
},
"description": "Individual responses to image annotation requests within the batch."
}
},
"id": "BatchAnnotateImagesResponse"
},
"DominantColorsAnnotation": {
"type": "object",
"properties": {
"colors": {
"description": "RGB color values with their score and pixel fraction.",
"type": "array",
"items": {
"$ref": "ColorInfo"
}
}
},
"id": "DominantColorsAnnotation",
"description": "Set of dominant colors and their corresponding scores."
},
"GoogleCloudVisionV1p3beta1Block": {
"id": "GoogleCloudVisionV1p3beta1Block",
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty",
"description": "Additional information detected for the block."
},
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"format": "float",
"type": "number"
},
"boundingBox": {
"description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).",
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
},
"paragraphs": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Paragraph"
},
"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.",
"type": "string",
"enum": [
"UNKNOWN",
"TEXT",
"TABLE",
"PICTURE",
"RULER",
"BARCODE"
],
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
"Table block.",
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
]
}
},
"description": "Logical element on the page.",
"type": "object"
},
"Image": {
"properties": {
"content": {
"format": "byte",
"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.",
"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": "ImageSource"
}
},
"id": "Image",
"description": "Client image to perform Google Cloud Vision API tasks over.",
"type": "object"
},
"ListProductsResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"products": {
"description": "List of products.",
"items": {
"$ref": "Product"
},
"type": "array"
}
},
"type": "object",
"description": "Response message for the `ListProducts` method.",
"id": "ListProductsResponse"
},
"GoogleCloudVisionV1p1beta1Symbol": {
"description": "A single symbol representation.",
"type": "object",
"id": "GoogleCloudVisionV1p1beta1Symbol",
"properties": {
"confidence": {
"type": "number",
"format": "float",
"description": "Confidence of the OCR results for the symbol. Range [0, 1]."
},
"property": {
"description": "Additional information detected for the symbol.",
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
},
"text": {
"description": "The actual UTF-8 representation of the symbol.",
"type": "string"
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"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)."
}
}
},
"GcsDestination": {
"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.",
"id": "GcsDestination",
"type": "object"
},
"GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": {
"id": "GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult",
"type": "object",
"properties": {
"objectAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation"
},
"description": "List of generic predictions for the object in the bounding box.",
"type": "array"
},
"results": {
"description": "List of results, one for each product match.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult"
},
"type": "array"
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "The bounding polygon around the product detected in the query image."
}
},
"description": "Information about the products similar to a single product in a query image."
},
"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.",
"id": "GoogleCloudVisionV1p3beta1NormalizedVertex",
"type": "object",
"properties": {
"y": {
"description": "Y coordinate.",
"type": "number",
"format": "float"
},
"x": {
"format": "float",
"type": "number",
"description": "X coordinate."
}
}
},
"GoogleCloudVisionV1p4beta1TextAnnotation": {
"description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.",
"type": "object",
"properties": {
"pages": {
"description": "List of pages detected by OCR.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Page"
}
},
"text": {
"type": "string",
"description": "UTF-8 text detected on the pages."
}
},
"id": "GoogleCloudVisionV1p4beta1TextAnnotation"
},
"AnnotateImageResponse": {
"properties": {
"cropHintsAnnotation": {
"$ref": "CropHintsAnnotation",
"description": "If present, crop hints have completed successfully."
},
"webDetection": {
"description": "If present, web detection has completed successfully.",
"$ref": "WebDetection"
},
"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"
},
"landmarkAnnotations": {
"type": "array",
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "EntityAnnotation"
}
},
"localizedObjectAnnotations": {
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"items": {
"$ref": "LocalizedObjectAnnotation"
},
"type": "array"
},
"productSearchResults": {
"description": "If present, product search has completed successfully.",
"$ref": "ProductSearchResults"
},
"faceAnnotations": {
"type": "array",
"items": {
"$ref": "FaceAnnotation"
},
"description": "If present, face detection has completed successfully."
},
"labelAnnotations": {
"items": {
"$ref": "EntityAnnotation"
},
"type": "array",
"description": "If present, label detection has completed successfully."
},
"textAnnotations": {
"items": {
"$ref": "EntityAnnotation"
},
"description": "If present, text (OCR) detection has completed successfully.",
"type": "array"
},
"logoAnnotations": {
"items": {
"$ref": "EntityAnnotation"
},
"type": "array",
"description": "If present, logo detection has completed successfully."
},
"safeSearchAnnotation": {
"$ref": "SafeSearchAnnotation",
"description": "If present, safe-search annotation has completed successfully."
},
"imagePropertiesAnnotation": {
"description": "If present, image properties were extracted successfully.",
"$ref": "ImageProperties"
},
"fullTextAnnotation": {
"$ref": "TextAnnotation",
"description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text."
},
"context": {
"$ref": "ImageAnnotationContext",
"description": "If present, contextual information is needed to understand where this image comes from."
}
},
"description": "Response to an image annotation request.",
"type": "object",
"id": "AnnotateImageResponse"
},
"AsyncBatchAnnotateFilesResponse": {
"description": "Response to an async batch file annotation request.",
"id": "AsyncBatchAnnotateFilesResponse",
"type": "object",
"properties": {
"responses": {
"type": "array",
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"items": {
"$ref": "AsyncAnnotateFileResponse"
}
}
}
},
"GoogleCloudVisionV1p2beta1ProductSearchResultsResult": {
"description": "Information about a product.",
"properties": {
"score": {
"format": "float",
"description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).",
"type": "number"
},
"product": {
"description": "The Product.",
"$ref": "GoogleCloudVisionV1p2beta1Product"
},
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult",
"type": "object"
},
"GoogleCloudVisionV1p4beta1Product": {
"id": "GoogleCloudVisionV1p4beta1Product",
"type": "object",
"description": "A Product contains ReferenceImages.",
"properties": {
"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."
},
"productCategory": {
"type": "string",
"description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products."
},
"productLabels": {
"description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ProductKeyValue"
},
"type": "array"
},
"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."
}
}
},
"GoogleCloudVisionV1p3beta1CropHintsAnnotation": {
"id": "GoogleCloudVisionV1p3beta1CropHintsAnnotation",
"description": "Set of crop hints that are used to generate new crops when serving images.",
"properties": {
"cropHints": {
"type": "array",
"description": "Crop hint results.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1CropHint"
}
}
},
"type": "object"
},
"GoogleCloudVisionV1p2beta1AnnotateImageResponse": {
"properties": {
"fullTextAnnotation": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotation",
"description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text."
},
"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"
},
"cropHintsAnnotation": {
"description": "If present, crop hints have completed successfully.",
"$ref": "GoogleCloudVisionV1p2beta1CropHintsAnnotation"
},
"imagePropertiesAnnotation": {
"description": "If present, image properties were extracted successfully.",
"$ref": "GoogleCloudVisionV1p2beta1ImageProperties"
},
"localizedObjectAnnotations": {
"type": "array",
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation"
}
},
"context": {
"$ref": "GoogleCloudVisionV1p2beta1ImageAnnotationContext",
"description": "If present, contextual information is needed to understand where this image comes from."
},
"textAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation"
},
"description": "If present, text (OCR) detection has completed successfully."
},
"faceAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1FaceAnnotation"
},
"type": "array",
"description": "If present, face detection has completed successfully."
},
"productSearchResults": {
"description": "If present, product search has completed successfully.",
"$ref": "GoogleCloudVisionV1p2beta1ProductSearchResults"
},
"labelAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation"
},
"type": "array",
"description": "If present, label detection has completed successfully."
},
"webDetection": {
"description": "If present, web detection has completed successfully.",
"$ref": "GoogleCloudVisionV1p2beta1WebDetection"
},
"logoAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation"
},
"description": "If present, logo detection has completed successfully."
},
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1EntityAnnotation"
},
"type": "array"
},
"safeSearchAnnotation": {
"description": "If present, safe-search annotation has completed successfully.",
"$ref": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation"
}
},
"description": "Response to an image annotation request.",
"id": "GoogleCloudVisionV1p2beta1AnnotateImageResponse",
"type": "object"
},
"GoogleCloudVisionV1p3beta1WebDetectionWebEntity": {
"properties": {
"entityId": {
"description": "Opaque entity ID.",
"type": "string"
},
"score": {
"format": "float",
"type": "number",
"description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries."
},
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
}
},
"description": "Entity deduced from similar images on the Internet.",
"id": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity",
"type": "object"
},
"BatchAnnotateFilesResponse": {
"description": "A list of file annotation responses.",
"type": "object",
"id": "BatchAnnotateFilesResponse",
"properties": {
"responses": {
"type": "array",
"description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.",
"items": {
"$ref": "AnnotateFileResponse"
}
}
}
},
"GoogleCloudVisionV1p4beta1NormalizedVertex": {
"type": "object",
"properties": {
"x": {
"type": "number",
"format": "float",
"description": "X coordinate."
},
"y": {
"description": "Y coordinate.",
"type": "number",
"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.",
"id": "GoogleCloudVisionV1p4beta1NormalizedVertex"
},
"GoogleCloudVisionV1p2beta1TextAnnotationTextProperty": {
"description": "Additional information detected on the structural component.",
"id": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty",
"properties": {
"detectedLanguages": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage"
},
"description": "A list of detected languages together with confidence."
},
"detectedBreak": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak",
"description": "Detected start or end of a text segment."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotation": {
"properties": {
"pages": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Page"
},
"description": "List of pages detected by OCR.",
"type": "array"
},
"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.",
"id": "GoogleCloudVisionV1p1beta1TextAnnotation",
"type": "object"
},
"GoogleCloudVisionV1p2beta1NormalizedVertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.",
"type": "object",
"properties": {
"x": {
"format": "float",
"description": "X coordinate.",
"type": "number"
},
"y": {
"type": "number",
"format": "float",
"description": "Y coordinate."
}
},
"id": "GoogleCloudVisionV1p2beta1NormalizedVertex"
},
"ImportProductSetsInputConfig": {
"id": "ImportProductSetsInputConfig",
"properties": {
"gcsSource": {
"$ref": "ImportProductSetsGcsSource",
"description": "The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line."
}
},
"type": "object",
"description": "The input content for the `ImportProductSets` method."
},
"GoogleCloudVisionV1p3beta1InputConfig": {
"description": "The desired input location and metadata.",
"id": "GoogleCloudVisionV1p3beta1InputConfig",
"type": "object",
"properties": {
"content": {
"format": "byte",
"description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.",
"type": "string"
},
"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": {
"$ref": "GoogleCloudVisionV1p3beta1GcsSource",
"description": "The Google Cloud Storage location to read the input from."
}
}
},
"CropHintsParams": {
"properties": {
"aspectRatios": {
"items": {
"type": "number",
"format": "float"
},
"type": "array",
"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": "object",
"description": "Parameters for crop hints annotation request.",
"id": "CropHintsParams"
},
"GoogleCloudVisionV1p4beta1Vertex": {
"type": "object",
"properties": {
"x": {
"format": "int32",
"type": "integer",
"description": "X coordinate."
},
"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.",
"id": "GoogleCloudVisionV1p4beta1Vertex"
},
"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"
},
"GoogleCloudVisionV1p2beta1OperationMetadata": {
"description": "Contains metadata for the BatchAnnotateImages operation.",
"type": "object",
"properties": {
"updateTime": {
"description": "The time when the operation result was last updated.",
"format": "google-datetime",
"type": "string"
},
"state": {
"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."
],
"type": "string"
},
"createTime": {
"type": "string",
"format": "google-datetime",
"description": "The time when the batch request was received."
}
},
"id": "GoogleCloudVisionV1p2beta1OperationMetadata"
},
"WebEntity": {
"properties": {
"score": {
"format": "float",
"description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.",
"type": "number"
},
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
},
"entityId": {
"type": "string",
"description": "Opaque entity ID."
}
},
"description": "Entity deduced from similar images on the Internet.",
"id": "WebEntity",
"type": "object"
},
"GoogleCloudVisionV1p4beta1CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
"type": "object",
"properties": {
"cropHints": {
"description": "Crop hint results.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1CropHint"
}
}
},
"id": "GoogleCloudVisionV1p4beta1CropHintsAnnotation"
},
"GoogleCloudVisionV1p3beta1Position": {
"properties": {
"z": {
"type": "number",
"format": "float",
"description": "Z coordinate (or depth)."
},
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
},
"x": {
"description": "X coordinate.",
"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.",
"id": "GoogleCloudVisionV1p3beta1Position",
"type": "object"
},
"GoogleCloudVisionV1p3beta1GcsDestination": {
"description": "The Google Cloud Storage location where the output will be written to.",
"id": "GoogleCloudVisionV1p3beta1GcsDestination",
"type": "object",
"properties": {
"uri": {
"description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p1beta1NormalizedVertex": {
"id": "GoogleCloudVisionV1p1beta1NormalizedVertex",
"description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.",
"type": "object",
"properties": {
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
},
"x": {
"format": "float",
"type": "number",
"description": "X coordinate."
}
}
},
"GoogleCloudVisionV1p1beta1BoundingPoly": {
"properties": {
"normalizedVertices": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1NormalizedVertex"
},
"type": "array",
"description": "The bounding polygon normalized vertices."
},
"vertices": {
"description": "The bounding polygon vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Vertex"
}
}
},
"id": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "A bounding polygon for the detected image annotation.",
"type": "object"
},
"GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse": {
"type": "object",
"description": "The response for a single offline file annotation request.",
"id": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse",
"properties": {
"outputConfig": {
"$ref": "GoogleCloudVisionV1p4beta1OutputConfig",
"description": "The output location and metadata from AsyncAnnotateFileRequest."
}
}
},
"AsyncAnnotateFileResponse": {
"description": "The response for a single offline file annotation request.",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "The output location and metadata from AsyncAnnotateFileRequest."
}
},
"id": "AsyncAnnotateFileResponse",
"type": "object"
},
"GoogleCloudVisionV1p3beta1FaceAnnotation": {
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly",
"description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated."
},
"angerLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Anger likelihood."
},
"joyLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Joy likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string"
},
"fdBoundingPoly": {
"description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix.",
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
},
"underExposedLikelihood": {
"description": "Under-exposed likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"detectionConfidence": {
"type": "number",
"format": "float",
"description": "Detection confidence. Range [0, 1]."
},
"landmarkingConfidence": {
"description": "Face landmarking confidence. Range [0, 1].",
"type": "number",
"format": "float"
},
"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"
},
"rollAngle": {
"type": "number",
"format": "float",
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180]."
},
"tiltAngle": {
"format": "float",
"description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].",
"type": "number"
},
"blurredLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"description": "Blurred likelihood.",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"headwearLikelihood": {
"type": "string",
"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."
]
},
"landmarks": {
"description": "Detected face landmarks.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark"
},
"type": "array"
},
"panAngle": {
"type": "number",
"format": "float",
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]."
},
"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"
}
},
"id": "GoogleCloudVisionV1p3beta1FaceAnnotation",
"description": "A face annotation object contains the results of face detection.",
"type": "object"
},
"GoogleCloudVisionV1p4beta1ProductSearchResultsResult": {
"properties": {
"score": {
"format": "float",
"description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).",
"type": "number"
},
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
},
"product": {
"description": "The Product.",
"$ref": "GoogleCloudVisionV1p4beta1Product"
}
},
"description": "Information about a product.",
"id": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult",
"type": "object"
},
"GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult": {
"description": "Information about the products similar to a single product in a query image.",
"type": "object",
"id": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult",
"properties": {
"objectAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation"
},
"description": "List of generic predictions for the object in the bounding box."
},
"boundingPoly": {
"description": "The bounding polygon around the product detected in the query image.",
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly"
},
"results": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult"
},
"type": "array",
"description": "List of results, one for each product match."
}
}
},
"AddProductToProductSetRequest": {
"description": "Request message for the `AddProductToProductSet` method.",
"type": "object",
"properties": {
"product": {
"type": "string",
"description": "Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`"
}
},
"id": "AddProductToProductSetRequest"
},
"WebDetectionParams": {
"properties": {
"includeGeoResults": {
"type": "boolean",
"description": "Whether to include results derived from the geo information in the image."
}
},
"id": "WebDetectionParams",
"description": "Parameters for web detection request.",
"type": "object"
},
"DetectedLanguage": {
"id": "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": {
"format": "float",
"description": "Confidence of detected language. Range [0, 1].",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": {
"type": "object",
"properties": {
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"confidence": {
"description": "Confidence of detected language. Range [0, 1].",
"format": "float",
"type": "number"
}
},
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage",
"description": "Detected language for a structural component."
},
"GoogleCloudVisionV1p3beta1GcsSource": {
"id": "GoogleCloudVisionV1p3beta1GcsSource",
"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."
}
},
"type": "object"
},
"GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation": {
"type": "object",
"description": "Set of detected objects with bounding boxes.",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "Image region to which this object belongs. This must be populated."
},
"score": {
"type": "number",
"description": "Score of the result. Range [0, 1].",
"format": "float"
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p2beta1LocalizedObjectAnnotation"
},
"ListProductsInProductSetResponse": {
"description": "Response message for the `ListProductsInProductSet` method.",
"type": "object",
"properties": {
"products": {
"items": {
"$ref": "Product"
},
"description": "The list of Products.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list."
}
},
"id": "ListProductsInProductSetResponse"
},
"GoogleCloudVisionV1p3beta1Page": {
"description": "Detected page from OCR.",
"properties": {
"confidence": {
"description": "Confidence of the OCR results on the page. Range [0, 1].",
"format": "float",
"type": "number"
},
"width": {
"type": "integer",
"format": "int32",
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
},
"blocks": {
"description": "List of blocks of text, images etc on this page.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Block"
},
"type": "array"
},
"property": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty",
"description": "Additional information detected on the page."
},
"height": {
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"type": "integer",
"format": "int32"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p3beta1Page"
},
"ProductSearchParams": {
"description": "Parameters for a product search request.",
"id": "ProductSearchParams",
"properties": {
"productSet": {
"type": "string",
"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`."
},
"boundingPoly": {
"$ref": "BoundingPoly",
"description": "The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied."
},
"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."
},
"filter": {
"description": "The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value. For example, \"(color = red OR color = blue) AND brand = Google\" is acceptable, but \"(color = red OR brand = Google)\" is not acceptable. \"color: red\" is not acceptable because it uses a ':' instead of an '='.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductKeyValue": {
"properties": {
"value": {
"description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.",
"type": "string"
},
"key": {
"type": "string",
"description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes."
}
},
"type": "object",
"description": "A product label represented as a key-value pair.",
"id": "GoogleCloudVisionV1p1beta1ProductKeyValue"
},
"Product": {
"id": "Product",
"type": "object",
"description": "A Product contains ReferenceImages.",
"properties": {
"name": {
"type": "string",
"description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product."
},
"description": {
"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"
},
"displayName": {
"type": "string",
"description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long."
},
"productLabels": {
"description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.",
"items": {
"$ref": "KeyValue"
},
"type": "array"
}
}
},
"GoogleCloudVisionV1p4beta1GcsDestination": {
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files."
}
},
"description": "The Google Cloud Storage location where the output will be written to.",
"id": "GoogleCloudVisionV1p4beta1GcsDestination"
},
"Position": {
"properties": {
"z": {
"format": "float",
"description": "Z coordinate (or depth).",
"type": "number"
},
"x": {
"format": "float",
"type": "number",
"description": "X coordinate."
},
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
}
},
"id": "Position",
"description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.",
"type": "object"
},
"GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse": {
"properties": {
"responses": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse"
},
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"type": "array"
}
},
"type": "object",
"description": "Response to an async batch file annotation request.",
"id": "GoogleCloudVisionV1p3beta1AsyncBatchAnnotateFilesResponse"
},
"GoogleCloudVisionV1p3beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Vertex"
},
"type": "array"
}
},
"id": "GoogleCloudVisionV1p3beta1BoundingPoly",
"type": "object"
},
"AnnotateImageRequest": {
"description": "Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.",
"type": "object",
"properties": {
"imageContext": {
"$ref": "ImageContext",
"description": "Additional context that may accompany the image."
},
"features": {
"type": "array",
"description": "Requested features.",
"items": {
"$ref": "Feature"
}
},
"image": {
"$ref": "Image",
"description": "The image to be processed."
}
},
"id": "AnnotateImageRequest"
},
"Feature": {
"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.",
"id": "Feature",
"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"
],
"enumDescriptions": [
"Unspecified feature type.",
"Run face detection.",
"Run landmark detection.",
"Run logo detection.",
"Run label detection.",
"Run text detection / optical character recognition (OCR). Text detection is optimized for areas of text within a larger image; if the image is a document, use `DOCUMENT_TEXT_DETECTION` instead.",
"Run dense text document OCR. Takes precedence when both `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.",
"Run Safe Search to detect potentially unsafe or undesirable content.",
"Compute a set of image properties, such as the image's dominant colors.",
"Run crop hints.",
"Run web detection.",
"Run Product Search.",
"Run localizer for object detection."
],
"description": "The feature type."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.",
"format": "int32"
},
"model": {
"type": "string",
"description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\"."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation": {
"description": "Prediction for what the object in the bounding box is.",
"properties": {
"score": {
"description": "Score of the result. Range [0, 1].",
"type": "number",
"format": "float"
},
"mid": {
"type": "string",
"description": "Object ID that should align with EntityAnnotation mid."
},
"name": {
"type": "string",
"description": "Object name, expressed in its `language_code` language."
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
}
},
"type": "object",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebLabel": {
"type": "object",
"description": "Label to provide extra metadata for the web detection.",
"properties": {
"languageCode": {
"description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"label": {
"description": "Label for extra metadata.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel"
},
"GoogleCloudVisionV1p2beta1WebDetectionWebImage": {
"properties": {
"score": {
"type": "number",
"format": "float",
"description": "(Deprecated) Overall relevancy score for the image."
},
"url": {
"description": "The result image URL.",
"type": "string"
}
},
"description": "Metadata for online images.",
"id": "GoogleCloudVisionV1p2beta1WebDetectionWebImage",
"type": "object"
},
"GoogleCloudVisionV1p4beta1AnnotateImageResponse": {
"properties": {
"faceAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1FaceAnnotation"
},
"type": "array",
"description": "If present, face detection has completed successfully."
},
"textAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation"
},
"description": "If present, text (OCR) detection has completed successfully.",
"type": "array"
},
"context": {
"description": "If present, contextual information is needed to understand where this image comes from.",
"$ref": "GoogleCloudVisionV1p4beta1ImageAnnotationContext"
},
"localizedObjectAnnotations": {
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation"
}
},
"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": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetection",
"description": "If present, web detection has completed successfully."
},
"safeSearchAnnotation": {
"description": "If present, safe-search annotation has completed successfully.",
"$ref": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation"
},
"imagePropertiesAnnotation": {
"description": "If present, image properties were extracted successfully.",
"$ref": "GoogleCloudVisionV1p4beta1ImageProperties"
},
"productSearchResults": {
"$ref": "GoogleCloudVisionV1p4beta1ProductSearchResults",
"description": "If present, product search has completed successfully."
},
"labelAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation"
},
"description": "If present, label detection has completed successfully."
},
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation"
},
"type": "array"
},
"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"
},
"logoAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1EntityAnnotation"
},
"type": "array",
"description": "If present, logo detection has completed successfully."
},
"cropHintsAnnotation": {
"description": "If present, crop hints have completed successfully.",
"$ref": "GoogleCloudVisionV1p4beta1CropHintsAnnotation"
}
},
"type": "object",
"description": "Response to an image annotation request.",
"id": "GoogleCloudVisionV1p4beta1AnnotateImageResponse"
},
"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."
}
},
"type": "object",
"description": "A product label represented as a key-value pair.",
"id": "GoogleCloudVisionV1p2beta1ProductKeyValue"
},
"Color": {
"properties": {
"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 to be rendered as a solid color (as if the alpha value had been explicitly given with a value of 1.0).",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"type": "number",
"format": "float"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"type": "number",
"format": "float",
"description": "The amount of red in the color as a value in the interval [0, 1]."
}
},
"type": "object",
"description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/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, as well. Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space. Note: when color equality needs to be decided, implementations, unless documented otherwise, will treat two colors to be equal if all their red, green, blue and alpha values each differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...",
"id": "Color"
},
"GoogleCloudVisionV1p1beta1ImageProperties": {
"properties": {
"dominantColors": {
"$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
"description": "If present, dominant colors completed successfully."
}
},
"id": "GoogleCloudVisionV1p1beta1ImageProperties",
"type": "object",
"description": "Stores image properties, such as dominant colors."
},
"ImageProperties": {
"properties": {
"dominantColors": {
"$ref": "DominantColorsAnnotation",
"description": "If present, dominant colors completed successfully."
}
},
"description": "Stores image properties, such as dominant colors.",
"id": "ImageProperties",
"type": "object"
},
"GoogleCloudVisionV1p2beta1DominantColorsAnnotation": {
"properties": {
"colors": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1ColorInfo"
},
"description": "RGB color values with their score and pixel fraction."
}
},
"id": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation",
"description": "Set of dominant colors and their corresponding scores.",
"type": "object"
},
"GoogleCloudVisionV1p3beta1Symbol": {
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty",
"description": "Additional information detected for the symbol."
},
"text": {
"type": "string",
"description": "The actual UTF-8 representation of the symbol."
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly",
"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)."
},
"confidence": {
"format": "float",
"description": "Confidence of the OCR results for the symbol. Range [0, 1].",
"type": "number"
}
},
"description": "A single symbol representation.",
"id": "GoogleCloudVisionV1p3beta1Symbol",
"type": "object"
},
"GoogleCloudVisionV1p2beta1LocationInfo": {
"description": "Detected entity location information.",
"type": "object",
"properties": {
"latLng": {
"description": "lat/long location coordinates.",
"$ref": "LatLng"
}
},
"id": "GoogleCloudVisionV1p2beta1LocationInfo"
},
"Word": {
"properties": {
"property": {
"$ref": "TextProperty",
"description": "Additional information detected for the word."
},
"boundingBox": {
"description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).",
"$ref": "BoundingPoly"
},
"symbols": {
"type": "array",
"items": {
"$ref": "Symbol"
},
"description": "List of symbols in the word. The order of the symbols follows the natural reading order."
},
"confidence": {
"description": "Confidence of the OCR results for the word. Range [0, 1].",
"format": "float",
"type": "number"
}
},
"description": "A word representation.",
"id": "Word",
"type": "object"
},
"BoundingPoly": {
"type": "object",
"description": "A bounding polygon for the detected image annotation.",
"properties": {
"normalizedVertices": {
"type": "array",
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "NormalizedVertex"
}
},
"vertices": {
"description": "The bounding polygon vertices.",
"type": "array",
"items": {
"$ref": "Vertex"
}
}
},
"id": "BoundingPoly"
},
"GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation": {
"type": "object",
"properties": {
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
},
"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": "GoogleCloudVisionV1p1beta1BoundingPoly"
},
"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."
},
"score": {
"format": "float",
"type": "number",
"description": "Score of the result. Range [0, 1]."
}
},
"description": "Set of detected objects with bounding boxes.",
"id": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation"
},
"GoogleCloudVisionV1p2beta1Word": {
"description": "A word representation.",
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty",
"description": "Additional information detected for the word."
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"confidence": {
"format": "float",
"type": "number",
"description": "Confidence of the OCR results for the word. Range [0, 1]."
},
"symbols": {
"description": "List of symbols in the word. The order of the symbols follows the natural reading order.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1Symbol"
},
"type": "array"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1Word"
},
"GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": {
"type": "object",
"properties": {
"position": {
"description": "Face landmark position.",
"$ref": "GoogleCloudVisionV1p1beta1Position"
},
"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"
],
"description": "Face landmark type.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark",
"description": "A face-specific landmark (for example, a face feature)."
},
"GoogleCloudVisionV1p3beta1ImageProperties": {
"properties": {
"dominantColors": {
"description": "If present, dominant colors completed successfully.",
"$ref": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p3beta1ImageProperties",
"description": "Stores image properties, such as dominant colors."
},
"GoogleCloudVisionV1p3beta1ReferenceImage": {
"properties": {
"name": {
"description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image.",
"type": "string"
},
"uri": {
"type": "string",
"description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`."
},
"boundingPolys": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
},
"type": "array",
"description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not)."
}
},
"id": "GoogleCloudVisionV1p3beta1ReferenceImage",
"description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.",
"type": "object"
},
"GoogleCloudVisionV1p3beta1TextAnnotationTextProperty": {
"properties": {
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages together with confidence."
},
"detectedBreak": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak",
"description": "Detected start or end of a text segment."
}
},
"description": "Additional information detected on the structural component.",
"id": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty",
"type": "object"
},
"GoogleCloudVisionV1p4beta1Position": {
"id": "GoogleCloudVisionV1p4beta1Position",
"properties": {
"y": {
"format": "float",
"type": "number",
"description": "Y coordinate."
},
"z": {
"type": "number",
"description": "Z coordinate (or depth).",
"format": "float"
},
"x": {
"type": "number",
"description": "X 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"
},
"GoogleCloudVisionV1p1beta1ImageAnnotationContext": {
"properties": {
"pageNumber": {
"format": "int32",
"description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.",
"type": "integer"
},
"uri": {
"description": "The URI of the file used to produce the image.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext",
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image."
},
"DetectedBreak": {
"id": "DetectedBreak",
"type": "object",
"description": "Detected start or end of a structural component.",
"properties": {
"type": {
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
],
"description": "Detected break type.",
"type": "string",
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
"Sure space (very wide).",
"Line-wrapping break.",
"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
"Line break that ends a paragraph."
]
},
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
}
}
},
"GoogleCloudVisionV1p3beta1AnnotateFileResponse": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32",
"description": "This field gives the total number of pages in the file."
},
"responses": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1AnnotateImageResponse"
},
"type": "array",
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set."
},
"error": {
"description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.",
"$ref": "Status"
},
"inputConfig": {
"$ref": "GoogleCloudVisionV1p3beta1InputConfig",
"description": "Information about the file for which this response is generated."
}
},
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.",
"id": "GoogleCloudVisionV1p3beta1AnnotateFileResponse"
},
"GoogleCloudVisionV1p2beta1Block": {
"id": "GoogleCloudVisionV1p2beta1Block",
"description": "Logical element on the page.",
"type": "object",
"properties": {
"blockType": {
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
"Table block.",
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
],
"type": "string",
"description": "Detected block type (text, image etc) for this block.",
"enum": [
"UNKNOWN",
"TEXT",
"TABLE",
"PICTURE",
"RULER",
"BARCODE"
]
},
"property": {
"description": "Additional information detected for the block.",
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty"
},
"confidence": {
"type": "number",
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"format": "float"
},
"paragraphs": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1Paragraph"
},
"description": "List of paragraphs in this block (if this blocks is of type text)."
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"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)."
}
}
},
"GoogleCloudVisionV1p4beta1TextAnnotationTextProperty": {
"properties": {
"detectedLanguages": {
"description": "A list of detected languages together with confidence.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage"
}
},
"detectedBreak": {
"description": "Detected start or end of a text segment.",
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak"
}
},
"type": "object",
"description": "Additional information detected on the structural component.",
"id": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty"
},
"GoogleCloudVisionV1p3beta1OperationMetadata": {
"description": "Contains metadata for the BatchAnnotateImages operation.",
"properties": {
"state": {
"description": "Current state of the batch operation.",
"enum": [
"STATE_UNSPECIFIED",
"CREATED",
"RUNNING",
"DONE",
"CANCELLED"
],
"enumDescriptions": [
"Invalid.",
"Request is received.",
"Request is actively being processed.",
"The batch processing is done.",
"The batch processing was cancelled."
],
"type": "string"
},
"createTime": {
"description": "The time when the batch request was received.",
"type": "string",
"format": "google-datetime"
},
"updateTime": {
"type": "string",
"description": "The time when the operation result was last updated.",
"format": "google-datetime"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p3beta1OperationMetadata"
},
"GoogleCloudVisionV1p1beta1GcsDestination": {
"type": "object",
"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": "GoogleCloudVisionV1p1beta1GcsDestination"
},
"SafeSearchAnnotation": {
"id": "SafeSearchAnnotation",
"type": "object",
"properties": {
"violence": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Likelihood that this image contains violent content."
},
"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.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"racy": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas."
},
"adult": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities."
},
"medical": {
"description": "Likelihood that this is a medical image.",
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
}
},
"description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)."
},
"GoogleCloudVisionV1p3beta1ImportProductSetsResponse": {
"description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.",
"properties": {
"referenceImages": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ReferenceImage"
},
"description": "The list of reference_images that are imported successfully."
},
"statuses": {
"type": "array",
"description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.",
"items": {
"$ref": "Status"
}
}
},
"id": "GoogleCloudVisionV1p3beta1ImportProductSetsResponse",
"type": "object"
},
"GoogleCloudVisionV1p4beta1OperationMetadata": {
"id": "GoogleCloudVisionV1p4beta1OperationMetadata",
"type": "object",
"description": "Contains metadata for the BatchAnnotateImages operation.",
"properties": {
"updateTime": {
"description": "The time when the operation result was last updated.",
"type": "string",
"format": "google-datetime"
},
"createTime": {
"description": "The time when the batch request was received.",
"type": "string",
"format": "google-datetime"
},
"state": {
"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."
],
"type": "string"
}
}
},
"GoogleCloudVisionV1p4beta1OutputConfig": {
"type": "object",
"description": "The desired output location and metadata.",
"id": "GoogleCloudVisionV1p4beta1OutputConfig",
"properties": {
"batchSize": {
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.",
"type": "integer",
"format": "int32"
},
"gcsDestination": {
"$ref": "GoogleCloudVisionV1p4beta1GcsDestination",
"description": "The Google Cloud Storage location to write the output(s) to."
}
}
},
"GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse": {
"type": "object",
"properties": {
"outputConfig": {
"description": "The output location and metadata from AsyncAnnotateFileRequest.",
"$ref": "GoogleCloudVisionV1p3beta1OutputConfig"
}
},
"description": "The response for a single offline file annotation request.",
"id": "GoogleCloudVisionV1p3beta1AsyncAnnotateFileResponse"
},
"GoogleCloudVisionV1p2beta1ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"properties": {
"score": {
"format": "float",
"description": "Image-specific score for this color. Value in range [0, 1].",
"type": "number"
},
"pixelFraction": {
"type": "number",
"description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].",
"format": "float"
},
"color": {
"$ref": "Color",
"description": "RGB components of the color."
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1ColorInfo"
},
"LocationInfo": {
"type": "object",
"properties": {
"latLng": {
"description": "lat/long location coordinates.",
"$ref": "LatLng"
}
},
"id": "LocationInfo",
"description": "Detected entity location information."
},
"GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": {
"properties": {
"position": {
"description": "Face landmark position.",
"$ref": "GoogleCloudVisionV1p4beta1Position"
},
"type": {
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
"RIGHT_EYE",
"LEFT_OF_LEFT_EYEBROW",
"RIGHT_OF_LEFT_EYEBROW",
"LEFT_OF_RIGHT_EYEBROW",
"RIGHT_OF_RIGHT_EYEBROW",
"MIDPOINT_BETWEEN_EYES",
"NOSE_TIP",
"UPPER_LIP",
"LOWER_LIP",
"MOUTH_LEFT",
"MOUTH_RIGHT",
"MOUTH_CENTER",
"NOSE_BOTTOM_RIGHT",
"NOSE_BOTTOM_LEFT",
"NOSE_BOTTOM_CENTER",
"LEFT_EYE_TOP_BOUNDARY",
"LEFT_EYE_RIGHT_CORNER",
"LEFT_EYE_BOTTOM_BOUNDARY",
"LEFT_EYE_LEFT_CORNER",
"RIGHT_EYE_TOP_BOUNDARY",
"RIGHT_EYE_RIGHT_CORNER",
"RIGHT_EYE_BOTTOM_BOUNDARY",
"RIGHT_EYE_LEFT_CORNER",
"LEFT_EYEBROW_UPPER_MIDPOINT",
"RIGHT_EYEBROW_UPPER_MIDPOINT",
"LEFT_EAR_TRAGION",
"RIGHT_EAR_TRAGION",
"LEFT_EYE_PUPIL",
"RIGHT_EYE_PUPIL",
"FOREHEAD_GLABELLA",
"CHIN_GNATHION",
"CHIN_LEFT_GONION",
"CHIN_RIGHT_GONION",
"LEFT_CHEEK_CENTER",
"RIGHT_CHEEK_CENTER"
],
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
"Left eye.",
"Right eye.",
"Left of left eyebrow.",
"Right of left eyebrow.",
"Left of right eyebrow.",
"Right of right eyebrow.",
"Midpoint between eyes.",
"Nose tip.",
"Upper lip.",
"Lower lip.",
"Mouth left.",
"Mouth right.",
"Mouth center.",
"Nose, bottom right.",
"Nose, bottom left.",
"Nose, bottom center.",
"Left eye, top boundary.",
"Left eye, right corner.",
"Left eye, bottom boundary.",
"Left eye, left corner.",
"Right eye, top boundary.",
"Right eye, right corner.",
"Right eye, bottom boundary.",
"Right eye, left corner.",
"Left eyebrow, upper midpoint.",
"Right eyebrow, upper midpoint.",
"Left ear tragion.",
"Right ear tragion.",
"Left eye pupil.",
"Right eye pupil.",
"Forehead glabella.",
"Chin gnathion.",
"Chin left gonion.",
"Chin right gonion.",
"Left cheek center.",
"Right cheek center."
],
"description": "Face landmark type.",
"type": "string"
}
},
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
"id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebImage": {
"description": "Metadata for online images.",
"type": "object",
"properties": {
"score": {
"format": "float",
"description": "(Deprecated) Overall relevancy score for the image.",
"type": "number"
},
"url": {
"description": "The result image URL.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
},
"InputConfig": {
"description": "The desired input location and metadata.",
"type": "object",
"id": "InputConfig",
"properties": {
"gcsSource": {
"description": "The Google Cloud Storage location to read the input from.",
"$ref": "GcsSource"
},
"mimeType": {
"type": "string",
"description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported."
},
"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.",
"type": "string",
"format": "byte"
}
}
},
"GoogleCloudVisionV1p4beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudVisionV1p4beta1BoundingPoly",
"type": "object",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1NormalizedVertex"
}
},
"vertices": {
"description": "The bounding polygon vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Vertex"
}
}
}
},
"GoogleCloudVisionV1p4beta1Page": {
"type": "object",
"id": "GoogleCloudVisionV1p4beta1Page",
"properties": {
"height": {
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"type": "integer",
"format": "int32"
},
"confidence": {
"format": "float",
"type": "number",
"description": "Confidence of the OCR results on the page. Range [0, 1]."
},
"width": {
"format": "int32",
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"type": "integer"
},
"property": {
"description": "Additional information detected on the page.",
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty"
},
"blocks": {
"type": "array",
"description": "List of blocks of text, images etc on this page.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Block"
}
}
},
"description": "Detected page from OCR."
},
"AsyncAnnotateFileRequest": {
"description": "An offline file annotation request.",
"type": "object",
"id": "AsyncAnnotateFileRequest",
"properties": {
"imageContext": {
"description": "Additional context that may accompany the image(s) in the file.",
"$ref": "ImageContext"
},
"outputConfig": {
"description": "Required. The desired output location and metadata (e.g. format).",
"$ref": "OutputConfig"
},
"features": {
"type": "array",
"items": {
"$ref": "Feature"
},
"description": "Required. Requested features."
},
"inputConfig": {
"$ref": "InputConfig",
"description": "Required. Information about the input file."
}
}
},
"GoogleCloudVisionV1p1beta1AnnotateFileResponse": {
"type": "object",
"id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse",
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.",
"properties": {
"totalPages": {
"format": "int32",
"type": "integer",
"description": "This field gives the total number of pages in the file."
},
"inputConfig": {
"description": "Information about the file for which this response is generated.",
"$ref": "GoogleCloudVisionV1p1beta1InputConfig"
},
"responses": {
"type": "array",
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse"
}
},
"error": {
"description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.",
"$ref": "Status"
}
}
},
"BatchAnnotateFilesRequest": {
"type": "object",
"id": "BatchAnnotateFilesRequest",
"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"
},
"requests": {
"items": {
"$ref": "AnnotateFileRequest"
},
"type": "array",
"description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest."
}
},
"description": "A list of requests to annotate files using the BatchAnnotateFiles API."
},
"ProductSearchResults": {
"id": "ProductSearchResults",
"properties": {
"indexTime": {
"format": "google-datetime",
"type": "string",
"description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results."
},
"productGroupedResults": {
"items": {
"$ref": "GroupedResult"
},
"type": "array",
"description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results."
},
"results": {
"description": "List of results, one for each product match.",
"type": "array",
"items": {
"$ref": "Result"
}
}
},
"description": "Results for a product search request.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1OperationMetadata": {
"properties": {
"state": {
"enumDescriptions": [
"Invalid.",
"Request is received.",
"Request is actively being processed.",
"The batch processing is done.",
"The batch processing was cancelled."
],
"description": "Current state of the batch operation.",
"type": "string",
"enum": [
"STATE_UNSPECIFIED",
"CREATED",
"RUNNING",
"DONE",
"CANCELLED"
]
},
"createTime": {
"type": "string",
"format": "google-datetime",
"description": "The time when the batch request was received."
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"description": "The time when the operation result was last updated."
}
},
"type": "object",
"id": "GoogleCloudVisionV1p1beta1OperationMetadata",
"description": "Contains metadata for the BatchAnnotateImages operation."
},
"Property": {
"properties": {
"uint64Value": {
"type": "string",
"description": "Value of numeric properties.",
"format": "uint64"
},
"name": {
"description": "Name of the property.",
"type": "string"
},
"value": {
"description": "Value of the property.",
"type": "string"
}
},
"description": "A `Property` consists of a user-supplied name/value pair.",
"type": "object",
"id": "Property"
},
"GoogleCloudVisionV1p2beta1GcsDestination": {
"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": "GoogleCloudVisionV1p2beta1GcsDestination",
"type": "object"
},
"WebDetection": {
"properties": {
"partialMatchingImages": {
"items": {
"$ref": "WebImage"
},
"type": "array",
"description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops."
},
"bestGuessLabels": {
"items": {
"$ref": "WebLabel"
},
"description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.",
"type": "array"
},
"pagesWithMatchingImages": {
"items": {
"$ref": "WebPage"
},
"type": "array",
"description": "Web pages containing the matching images from the Internet."
},
"fullMatchingImages": {
"items": {
"$ref": "WebImage"
},
"type": "array",
"description": "Fully matching images from the Internet. Can include resized copies of the query image."
},
"webEntities": {
"description": "Deduced entities from similar images on the Internet.",
"type": "array",
"items": {
"$ref": "WebEntity"
}
},
"visuallySimilarImages": {
"description": "The visually similar image results.",
"items": {
"$ref": "WebImage"
},
"type": "array"
}
},
"description": "Relevant information for the image from the Internet.",
"type": "object",
"id": "WebDetection"
},
"GoogleCloudVisionV1p3beta1WebDetectionWebImage": {
"description": "Metadata for online images.",
"type": "object",
"id": "GoogleCloudVisionV1p3beta1WebDetectionWebImage",
"properties": {
"url": {
"type": "string",
"description": "The result image URL."
},
"score": {
"format": "float",
"type": "number",
"description": "(Deprecated) Overall relevancy score for the image."
}
}
},
"GoogleCloudVisionV1p2beta1InputConfig": {
"description": "The desired input location and metadata.",
"type": "object",
"id": "GoogleCloudVisionV1p2beta1InputConfig",
"properties": {
"content": {
"format": "byte",
"type": "string",
"description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests."
},
"mimeType": {
"type": "string",
"description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported."
},
"gcsSource": {
"$ref": "GoogleCloudVisionV1p2beta1GcsSource",
"description": "The Google Cloud Storage location to read the input from."
}
}
},
"ProductSetPurgeConfig": {
"properties": {
"productSetId": {
"description": "The ProductSet that contains the Products to delete. If a Product is a member of product_set_id in addition to other ProductSets, the Product will still be deleted.",
"type": "string"
}
},
"id": "ProductSetPurgeConfig",
"description": "Config to control which ProductSet contains the Products to be deleted.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": {
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult",
"type": "object",
"description": "Information about the products similar to a single product in a query image.",
"properties": {
"results": {
"description": "List of results, one for each product match.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult"
}
},
"objectAnnotations": {
"description": "List of generic predictions for the object in the bounding box.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation"
},
"type": "array"
},
"boundingPoly": {
"description": "The bounding polygon around the product detected in the query image.",
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
}
}
},
"GoogleCloudVisionV1p4beta1Word": {
"id": "GoogleCloudVisionV1p4beta1Word",
"type": "object",
"properties": {
"confidence": {
"type": "number",
"description": "Confidence of the OCR results for the word. Range [0, 1].",
"format": "float"
},
"symbols": {
"description": "List of symbols in the word. The order of the symbols follows the natural reading order.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Symbol"
}
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"property": {
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty",
"description": "Additional information detected for the word."
}
},
"description": "A word representation."
},
"GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation": {
"type": "object",
"id": "GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation",
"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."
},
"mid": {
"type": "string",
"description": "Object ID that should align with EntityAnnotation mid."
},
"score": {
"description": "Score of the result. Range [0, 1].",
"type": "number",
"format": "float"
}
},
"description": "Prediction for what the object in the bounding box is."
},
"GoogleCloudVisionV1p1beta1EntityAnnotation": {
"type": "object",
"id": "GoogleCloudVisionV1p1beta1EntityAnnotation",
"description": "Set of detected entity features.",
"properties": {
"description": {
"type": "string",
"description": "Entity textual description, expressed in its `locale` language."
},
"boundingPoly": {
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.",
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
},
"topicality": {
"format": "float",
"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]."
},
"properties": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Property"
},
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity."
},
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
"type": "number"
},
"locations": {
"description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1LocationInfo"
}
},
"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"
},
"mid": {
"type": "string",
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."
},
"locale": {
"type": "string",
"description": "The language code for the locale in which the entity textual `description` is expressed."
}
}
},
"GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse": {
"description": "Response to an async batch file annotation request.",
"type": "object",
"id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse",
"properties": {
"responses": {
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse"
},
"type": "array"
}
}
},
"GoogleCloudVisionV1p4beta1EntityAnnotation": {
"description": "Set of detected entity features.",
"type": "object",
"id": "GoogleCloudVisionV1p4beta1EntityAnnotation",
"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"
},
"locale": {
"type": "string",
"description": "The language code for the locale in which the entity textual `description` is expressed."
},
"confidence": {
"format": "float",
"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]."
},
"description": {
"type": "string",
"description": "Entity textual description, expressed in its `locale` language."
},
"properties": {
"type": "array",
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Property"
}
},
"locations": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1LocationInfo"
},
"description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.",
"type": "array"
},
"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"
},
"score": {
"type": "number",
"description": "Overall score of the result. Range [0, 1].",
"format": "float"
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features."
}
}
},
"Empty": {
"id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {}
},
"GoogleCloudVisionV1p4beta1WebDetectionWebPage": {
"id": "GoogleCloudVisionV1p4beta1WebDetectionWebPage",
"properties": {
"score": {
"format": "float",
"type": "number",
"description": "(Deprecated) Overall relevancy score for the web page."
},
"fullMatchingImages": {
"description": "Fully matching images on the page. Can include resized copies of the query image.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage"
}
},
"pageTitle": {
"type": "string",
"description": "Title for the web page, may contain HTML markups."
},
"partialMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage"
},
"description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"type": "array"
},
"url": {
"description": "The result web page URL.",
"type": "string"
}
},
"description": "Metadata for web pages.",
"type": "object"
},
"WebPage": {
"description": "Metadata for web pages.",
"type": "object",
"properties": {
"partialMatchingImages": {
"items": {
"$ref": "WebImage"
},
"description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"type": "array"
},
"url": {
"description": "The result web page URL.",
"type": "string"
},
"score": {
"type": "number",
"format": "float",
"description": "(Deprecated) Overall relevancy score for the web page."
},
"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.",
"items": {
"$ref": "WebImage"
},
"type": "array"
}
},
"id": "WebPage"
},
"GoogleCloudVisionV1p1beta1CropHint": {
"type": "object",
"properties": {
"confidence": {
"format": "float",
"type": "number",
"description": "Confidence of this being a salient region. Range [0, 1]."
},
"importanceFraction": {
"type": "number",
"format": "float",
"description": "Fraction of importance of this salient region with respect to the original image."
},
"boundingPoly": {
"description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.",
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
}
},
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"id": "GoogleCloudVisionV1p1beta1CropHint"
},
"ImageContext": {
"type": "object",
"id": "ImageContext",
"properties": {
"latLongRect": {
"description": "Not used.",
"$ref": "LatLongRect"
},
"webDetectionParams": {
"$ref": "WebDetectionParams",
"description": "Parameters for web detection."
},
"cropHintsParams": {
"$ref": "CropHintsParams",
"description": "Parameters for crop hints annotation request."
},
"productSearchParams": {
"description": "Parameters for product search.",
"$ref": "ProductSearchParams"
},
"languageHints": {
"type": "array",
"description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages).",
"items": {
"type": "string"
}
}
},
"description": "Image context and/or feature-specific parameters."
},
"GoogleCloudVisionV1p1beta1Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"id": "GoogleCloudVisionV1p1beta1Property",
"properties": {
"uint64Value": {
"format": "uint64",
"description": "Value of numeric properties.",
"type": "string"
},
"value": {
"type": "string",
"description": "Value of the property."
},
"name": {
"description": "Name of the property.",
"type": "string"
}
},
"type": "object"
},
"ListReferenceImagesResponse": {
"description": "Response message for the `ListReferenceImages` method.",
"type": "object",
"id": "ListReferenceImagesResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The next_page_token returned from a previous List request, if any."
},
"referenceImages": {
"description": "The list of reference images.",
"type": "array",
"items": {
"$ref": "ReferenceImage"
}
},
"pageSize": {
"format": "int32",
"description": "The maximum number of items to return. Default 10, maximum 100.",
"type": "integer"
}
}
},
"GoogleCloudVisionV1p3beta1Vertex": {
"id": "GoogleCloudVisionV1p3beta1Vertex",
"properties": {
"y": {
"description": "Y coordinate.",
"type": "integer",
"format": "int32"
},
"x": {
"type": "integer",
"format": "int32",
"description": "X coordinate."
}
},
"type": "object",
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image."
},
"GoogleCloudVisionV1p3beta1OutputConfig": {
"description": "The desired output location and metadata.",
"id": "GoogleCloudVisionV1p3beta1OutputConfig",
"type": "object",
"properties": {
"gcsDestination": {
"description": "The Google Cloud Storage location to write the output(s) to.",
"$ref": "GoogleCloudVisionV1p3beta1GcsDestination"
},
"batchSize": {
"format": "int32",
"type": "integer",
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations."
}
}
},
"GroupedResult": {
"type": "object",
"description": "Information about the products similar to a single product in a query image.",
"id": "GroupedResult",
"properties": {
"objectAnnotations": {
"description": "List of generic predictions for the object in the bounding box.",
"type": "array",
"items": {
"$ref": "ObjectAnnotation"
}
},
"results": {
"items": {
"$ref": "Result"
},
"type": "array",
"description": "List of results, one for each product match."
},
"boundingPoly": {
"description": "The bounding polygon around the product detected in the query image.",
"$ref": "BoundingPoly"
}
}
},
"GoogleCloudVisionV1p4beta1ImageAnnotationContext": {
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.",
"type": "object",
"properties": {
"uri": {
"description": "The URI of the file used to produce the image.",
"type": "string"
},
"pageNumber": {
"type": "integer",
"format": "int32",
"description": "If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image."
}
},
"id": "GoogleCloudVisionV1p4beta1ImageAnnotationContext"
},
"GoogleCloudVisionV1p4beta1ProductSearchResults": {
"description": "Results for a product search request.",
"id": "GoogleCloudVisionV1p4beta1ProductSearchResults",
"properties": {
"indexTime": {
"format": "google-datetime",
"description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.",
"type": "string"
},
"productGroupedResults": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult"
},
"description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.",
"type": "array"
},
"results": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ProductSearchResultsResult"
},
"description": "List of results, one for each product match.",
"type": "array"
}
},
"type": "object"
},
"Block": {
"description": "Logical element on the page.",
"type": "object",
"id": "Block",
"properties": {
"paragraphs": {
"description": "List of paragraphs in this block (if this blocks is of type text).",
"type": "array",
"items": {
"$ref": "Paragraph"
}
},
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"type": "number",
"format": "float"
},
"blockType": {
"description": "Detected block type (text, image etc) for this block.",
"enum": [
"UNKNOWN",
"TEXT",
"TABLE",
"PICTURE",
"RULER",
"BARCODE"
],
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
"Table block.",
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
],
"type": "string"
},
"property": {
"$ref": "TextProperty",
"description": "Additional information detected for the block."
},
"boundingBox": {
"$ref": "BoundingPoly",
"description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
}
}
},
"GoogleCloudVisionV1p2beta1Page": {
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty",
"description": "Additional information detected on the page."
},
"width": {
"type": "integer",
"format": "int32",
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
},
"height": {
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"format": "int32",
"type": "integer"
},
"blocks": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1Block"
},
"description": "List of blocks of text, images etc on this page."
},
"confidence": {
"type": "number",
"description": "Confidence of the OCR results on the page. Range [0, 1].",
"format": "float"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1Page",
"description": "Detected page from OCR."
},
"GoogleCloudVisionV1p1beta1ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"properties": {
"color": {
"$ref": "Color",
"description": "RGB components of the color."
},
"pixelFraction": {
"description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].",
"type": "number",
"format": "float"
},
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
"type": "number",
"format": "float"
}
},
"id": "GoogleCloudVisionV1p1beta1ColorInfo",
"type": "object"
},
"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).",
"type": "number",
"format": "float"
},
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": {
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
"properties": {
"type": {
"description": "Face landmark type.",
"type": "string",
"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"
]
},
"position": {
"description": "Face landmark position.",
"$ref": "GoogleCloudVisionV1p2beta1Position"
}
},
"id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark"
},
"ImageAnnotationContext": {
"id": "ImageAnnotationContext",
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.",
"type": "object",
"properties": {
"uri": {
"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"
}
}
},
"GoogleCloudVisionV1p4beta1ProductKeyValue": {
"properties": {
"key": {
"type": "string",
"description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes."
},
"value": {
"type": "string",
"description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes."
}
},
"description": "A product label represented as a key-value pair.",
"type": "object",
"id": "GoogleCloudVisionV1p4beta1ProductKeyValue"
},
"GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse": {
"type": "object",
"properties": {
"responses": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse"
},
"type": "array",
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest."
}
},
"description": "Response to an async batch file annotation request.",
"id": "GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesResponse"
},
"GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage": {
"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"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedLanguage"
},
"ListProductSetsResponse": {
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"productSets": {
"type": "array",
"description": "List of ProductSets.",
"items": {
"$ref": "ProductSet"
}
}
},
"id": "ListProductSetsResponse",
"type": "object",
"description": "Response message for the `ListProductSets` method."
},
"WebLabel": {
"id": "WebLabel",
"properties": {
"label": {
"type": "string",
"description": "Label for extra metadata."
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
}
},
"description": "Label to provide extra metadata for the web detection.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1Page": {
"properties": {
"property": {
"description": "Additional information detected on the page.",
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
},
"width": {
"type": "integer",
"format": "int32",
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
},
"blocks": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Block"
},
"description": "List of blocks of text, images etc on this page."
},
"confidence": {
"description": "Confidence of the OCR results on the page. Range [0, 1].",
"format": "float",
"type": "number"
},
"height": {
"type": "integer",
"format": "int32",
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
}
},
"id": "GoogleCloudVisionV1p1beta1Page",
"description": "Detected page from OCR.",
"type": "object"
},
"GoogleCloudVisionV1p4beta1FaceRecognitionResult": {
"id": "GoogleCloudVisionV1p4beta1FaceRecognitionResult",
"type": "object",
"properties": {
"celebrity": {
"description": "The Celebrity that this face was matched to.",
"$ref": "GoogleCloudVisionV1p4beta1Celebrity"
},
"confidence": {
"format": "float",
"type": "number",
"description": "Recognition confidence. Range [0, 1]."
}
},
"description": "Information about a face's identity."
},
"GoogleCloudVisionV1p3beta1CropHint": {
"type": "object",
"properties": {
"confidence": {
"type": "number",
"format": "float",
"description": "Confidence of this being a salient region. Range [0, 1]."
},
"importanceFraction": {
"type": "number",
"format": "float",
"description": "Fraction of importance of this salient region with respect to the original image."
},
"boundingPoly": {
"description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale.",
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
}
},
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"id": "GoogleCloudVisionV1p3beta1CropHint"
},
"GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation": {
"properties": {
"boundingPoly": {
"description": "Image region to which this object belongs. This must be populated.",
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
},
"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"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
},
"score": {
"description": "Score of the result. Range [0, 1].",
"type": "number",
"format": "float"
}
},
"type": "object",
"description": "Set of detected objects with bounding boxes.",
"id": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation"
},
"GoogleCloudVisionV1p2beta1WebDetectionWebPage": {
"type": "object",
"description": "Metadata for web pages.",
"id": "GoogleCloudVisionV1p2beta1WebDetectionWebPage",
"properties": {
"pageTitle": {
"type": "string",
"description": "Title for the web page, may contain HTML markups."
},
"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.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage"
},
"type": "array"
},
"score": {
"format": "float",
"type": "number",
"description": "(Deprecated) Overall relevancy score for the web page."
},
"fullMatchingImages": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage"
},
"description": "Fully matching images on the page. Can include resized copies of the query image."
},
"url": {
"description": "The result web page URL.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p2beta1AnnotateFileResponse": {
"id": "GoogleCloudVisionV1p2beta1AnnotateFileResponse",
"properties": {
"responses": {
"type": "array",
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1AnnotateImageResponse"
}
},
"error": {
"$ref": "Status",
"description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case."
},
"inputConfig": {
"$ref": "GoogleCloudVisionV1p2beta1InputConfig",
"description": "Information about the file for which this response is generated."
},
"totalPages": {
"description": "This field gives the total number of pages in the file.",
"format": "int32",
"type": "integer"
}
},
"type": "object",
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses."
},
"GoogleCloudVisionV1p3beta1TextAnnotation": {
"id": "GoogleCloudVisionV1p3beta1TextAnnotation",
"properties": {
"pages": {
"description": "List of pages detected by OCR.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Page"
},
"type": "array"
},
"text": {
"description": "UTF-8 text detected on the pages.",
"type": "string"
}
},
"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."
},
"WebImage": {
"properties": {
"score": {
"description": "(Deprecated) Overall relevancy score for the image.",
"type": "number",
"format": "float"
},
"url": {
"type": "string",
"description": "The result image URL."
}
},
"description": "Metadata for online images.",
"type": "object",
"id": "WebImage"
},
"GoogleCloudVisionV1p2beta1CropHint": {
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"type": "object",
"properties": {
"importanceFraction": {
"type": "number",
"description": "Fraction of importance of this salient region with respect to the original image.",
"format": "float"
},
"confidence": {
"format": "float",
"description": "Confidence of this being a salient region. Range [0, 1].",
"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": "GoogleCloudVisionV1p2beta1BoundingPoly"
}
},
"id": "GoogleCloudVisionV1p2beta1CropHint"
},
"GoogleCloudVisionV1p4beta1Block": {
"description": "Logical element on the page.",
"properties": {
"paragraphs": {
"description": "List of paragraphs in this block (if this blocks is of type text).",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Paragraph"
}
},
"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"
},
"blockType": {
"enum": [
"UNKNOWN",
"TEXT",
"TABLE",
"PICTURE",
"RULER",
"BARCODE"
],
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
"Table block.",
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
],
"type": "string",
"description": "Detected block type (text, image etc) for this block."
},
"property": {
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty",
"description": "Additional information detected for the block."
},
"confidence": {
"type": "number",
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"format": "float"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p4beta1Block"
},
"BatchOperationMetadata": {
"properties": {
"state": {
"enum": [
"STATE_UNSPECIFIED",
"PROCESSING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"type": "string",
"description": "The current state of the batch operation.",
"enumDescriptions": [
"Invalid.",
"Request is actively being processed.",
"The request is done and at least one item has been successfully processed.",
"The request is done and no item has been successfully processed.",
"The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request."
]
},
"submitTime": {
"format": "google-datetime",
"type": "string",
"description": "The time when the batch request was submitted to the server."
},
"endTime": {
"format": "google-datetime",
"description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.",
"type": "string"
}
},
"id": "BatchOperationMetadata",
"description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.",
"type": "object"
},
"CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
"id": "CropHintsAnnotation",
"type": "object",
"properties": {
"cropHints": {
"items": {
"$ref": "CropHint"
},
"description": "Crop hint results.",
"type": "array"
}
}
},
"GoogleCloudVisionV1p3beta1AnnotateImageResponse": {
"description": "Response to an image annotation request.",
"id": "GoogleCloudVisionV1p3beta1AnnotateImageResponse",
"properties": {
"cropHintsAnnotation": {
"$ref": "GoogleCloudVisionV1p3beta1CropHintsAnnotation",
"description": "If present, crop hints have completed successfully."
},
"safeSearchAnnotation": {
"description": "If present, safe-search annotation has completed successfully.",
"$ref": "GoogleCloudVisionV1p3beta1SafeSearchAnnotation"
},
"textAnnotations": {
"description": "If present, text (OCR) detection has completed successfully.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation"
}
},
"logoAnnotations": {
"type": "array",
"description": "If present, logo detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation"
}
},
"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"
},
"productSearchResults": {
"$ref": "GoogleCloudVisionV1p3beta1ProductSearchResults",
"description": "If present, product search has completed successfully."
},
"labelAnnotations": {
"type": "array",
"description": "If present, label detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation"
}
},
"landmarkAnnotations": {
"type": "array",
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1EntityAnnotation"
}
},
"faceAnnotations": {
"type": "array",
"description": "If present, face detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1FaceAnnotation"
}
},
"webDetection": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetection",
"description": "If present, web detection has completed successfully."
},
"context": {
"description": "If present, contextual information is needed to understand where this image comes from.",
"$ref": "GoogleCloudVisionV1p3beta1ImageAnnotationContext"
},
"localizedObjectAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1LocalizedObjectAnnotation"
},
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score."
},
"imagePropertiesAnnotation": {
"$ref": "GoogleCloudVisionV1p3beta1ImageProperties",
"description": "If present, image properties were extracted successfully."
},
"error": {
"$ref": "Status",
"description": "If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set."
}
},
"type": "object"
},
"GoogleCloudVisionV1p2beta1EntityAnnotation": {
"type": "object",
"properties": {
"score": {
"type": "number",
"description": "Overall score of the result. Range [0, 1].",
"format": "float"
},
"topicality": {
"description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].",
"format": "float",
"type": "number"
},
"locations": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1LocationInfo"
},
"type": "array",
"description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks."
},
"mid": {
"type": "string",
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."
},
"boundingPoly": {
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.",
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly"
},
"confidence": {
"description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].",
"type": "number",
"format": "float"
},
"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."
},
"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"
}
}
},
"id": "GoogleCloudVisionV1p2beta1EntityAnnotation",
"description": "Set of detected entity features."
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsResult": {
"type": "object",
"properties": {
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
},
"score": {
"type": "number",
"description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).",
"format": "float"
},
"product": {
"description": "The Product.",
"$ref": "GoogleCloudVisionV1p1beta1Product"
}
},
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult",
"description": "Information about a product."
},
"GoogleCloudVisionV1p4beta1WebDetection": {
"description": "Relevant information for the image from the Internet.",
"type": "object",
"id": "GoogleCloudVisionV1p4beta1WebDetection",
"properties": {
"partialMatchingImages": {
"description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage"
},
"type": "array"
},
"webEntities": {
"description": "Deduced entities from similar images on the Internet.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity"
},
"type": "array"
},
"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."
},
"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.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebImage"
},
"type": "array"
},
"pagesWithMatchingImages": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1WebDetectionWebPage"
},
"description": "Web pages containing the matching images from the Internet."
}
}
},
"GoogleCloudVisionV1p3beta1LocationInfo": {
"properties": {
"latLng": {
"$ref": "LatLng",
"description": "lat/long location coordinates."
}
},
"id": "GoogleCloudVisionV1p3beta1LocationInfo",
"description": "Detected entity location information.",
"type": "object"
},
"ImportProductSetsRequest": {
"type": "object",
"id": "ImportProductSetsRequest",
"description": "Request message for the `ImportProductSets` method.",
"properties": {
"inputConfig": {
"description": "Required. The input content for the list of requests.",
"$ref": "ImportProductSetsInputConfig"
}
}
},
"GoogleCloudVisionV1p1beta1Word": {
"description": "A word representation.",
"properties": {
"confidence": {
"type": "number",
"description": "Confidence of the OCR results for the word. Range [0, 1].",
"format": "float"
},
"symbols": {
"description": "List of symbols in the word. The order of the symbols follows the natural reading order.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Symbol"
},
"type": "array"
},
"property": {
"description": "Additional information detected for the word.",
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
}
},
"id": "GoogleCloudVisionV1p1beta1Word",
"type": "object"
},
"AnnotateFileResponse": {
"properties": {
"inputConfig": {
"description": "Information about the file for which this response is generated.",
"$ref": "InputConfig"
},
"responses": {
"type": "array",
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "AnnotateImageResponse"
}
},
"error": {
"description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case.",
"$ref": "Status"
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "This field gives the total number of pages in the file."
}
},
"id": "AnnotateFileResponse",
"type": "object",
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses."
},
"GoogleCloudVisionV1p4beta1ReferenceImage": {
"id": "GoogleCloudVisionV1p4beta1ReferenceImage",
"description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.",
"properties": {
"uri": {
"type": "string",
"description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`."
},
"boundingPolys": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly"
},
"description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).",
"type": "array"
},
"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"
}
},
"type": "object"
},
"TextAnnotation": {
"properties": {
"text": {
"description": "UTF-8 text detected on the pages.",
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "Page"
},
"description": "List of pages detected by OCR."
}
},
"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.",
"id": "TextAnnotation"
},
"GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation": {
"description": "Prediction for what the object in the bounding box is.",
"id": "GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Object name, expressed in its `language_code` language."
},
"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."
},
"score": {
"format": "float",
"type": "number",
"description": "Score of the result. Range [0, 1]."
}
}
},
"GoogleCloudVisionV1p3beta1BatchOperationMetadata": {
"id": "GoogleCloudVisionV1p3beta1BatchOperationMetadata",
"properties": {
"endTime": {
"description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.",
"type": "string",
"format": "google-datetime"
},
"submitTime": {
"format": "google-datetime",
"description": "The time when the batch request was submitted to the server.",
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"PROCESSING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"type": "string",
"enumDescriptions": [
"Invalid.",
"Request is actively being processed.",
"The request is done and at least one item has been successfully processed.",
"The request is done and no item has been successfully processed.",
"The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request."
],
"description": "The current state of the batch operation."
}
},
"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."
},
"GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak": {
"type": "object",
"description": "Detected start or end of a structural component.",
"properties": {
"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 break type.",
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
]
},
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
}
},
"id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedBreak"
},
"EntityAnnotation": {
"id": "EntityAnnotation",
"description": "Set of detected entity features.",
"type": "object",
"properties": {
"confidence": {
"format": "float",
"description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].",
"type": "number"
},
"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."
},
"description": {
"type": "string",
"description": "Entity textual description, expressed in its `locale` language."
},
"mid": {
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
"type": "string"
},
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
"type": "number"
},
"topicality": {
"format": "float",
"description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].",
"type": "number"
},
"properties": {
"items": {
"$ref": "Property"
},
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.",
"type": "array"
},
"boundingPoly": {
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features.",
"$ref": "BoundingPoly"
},
"locale": {
"description": "The language code for the locale in which the entity textual `description` is expressed.",
"type": "string"
}
}
},
"PurgeProductsRequest": {
"id": "PurgeProductsRequest",
"description": "Request message for the `PurgeProducts` method.",
"properties": {
"deleteOrphanProducts": {
"type": "boolean",
"description": "If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted."
},
"productSetPurgeConfig": {
"$ref": "ProductSetPurgeConfig",
"description": "Specify which ProductSet contains the Products to be deleted."
},
"force": {
"type": "boolean",
"description": "The default value is false. Override this value to true to actually perform the purge."
}
},
"type": "object"
},
"AsyncBatchAnnotateImagesRequest": {
"type": "object",
"description": "Request for async image annotation for a list of images.",
"id": "AsyncBatchAnnotateImagesRequest",
"properties": {
"requests": {
"description": "Required. Individual image annotation requests for this batch.",
"items": {
"$ref": "AnnotateImageRequest"
},
"type": "array"
},
"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"
},
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. The desired output location and metadata (e.g. format)."
}
}
},
"Page": {
"description": "Detected page from OCR.",
"properties": {
"confidence": {
"format": "float",
"type": "number",
"description": "Confidence of the OCR results on the page. Range [0, 1]."
},
"height": {
"type": "integer",
"format": "int32",
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
},
"blocks": {
"type": "array",
"items": {
"$ref": "Block"
},
"description": "List of blocks of text, images etc on this page."
},
"property": {
"description": "Additional information detected on the page.",
"$ref": "TextProperty"
},
"width": {
"type": "integer",
"format": "int32",
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels."
}
},
"type": "object",
"id": "Page"
},
"GoogleCloudVisionV1p3beta1Word": {
"id": "GoogleCloudVisionV1p3beta1Word",
"description": "A word representation.",
"properties": {
"confidence": {
"type": "number",
"format": "float",
"description": "Confidence of the OCR results for the word. Range [0, 1]."
},
"property": {
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty",
"description": "Additional information detected for the word."
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly",
"description": "The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"symbols": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Symbol"
},
"type": "array",
"description": "List of symbols in the word. The order of the symbols follows the natural reading order."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResults": {
"type": "object",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResults",
"properties": {
"indexTime": {
"format": "google-datetime",
"type": "string",
"description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results."
},
"productGroupedResults": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult"
},
"description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.",
"type": "array"
},
"results": {
"description": "List of results, one for each product match.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult"
}
}
},
"description": "Results for a product search request."
},
"GoogleCloudVisionV1p2beta1ImageProperties": {
"type": "object",
"id": "GoogleCloudVisionV1p2beta1ImageProperties",
"properties": {
"dominantColors": {
"$ref": "GoogleCloudVisionV1p2beta1DominantColorsAnnotation",
"description": "If present, dominant colors completed successfully."
}
},
"description": "Stores image properties, such as dominant colors."
},
"GoogleCloudVisionV1p4beta1InputConfig": {
"type": "object",
"id": "GoogleCloudVisionV1p4beta1InputConfig",
"description": "The desired input location and metadata.",
"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": {
"description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.",
"type": "string",
"format": "byte"
},
"gcsSource": {
"description": "The Google Cloud Storage location to read the input from.",
"$ref": "GoogleCloudVisionV1p4beta1GcsSource"
}
}
},
"GoogleCloudVisionV1p4beta1CropHint": {
"type": "object",
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"id": "GoogleCloudVisionV1p4beta1CropHint",
"properties": {
"confidence": {
"type": "number",
"description": "Confidence of this being a salient region. Range [0, 1].",
"format": "float"
},
"importanceFraction": {
"format": "float",
"description": "Fraction of importance of this salient region with respect to the original image.",
"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": "GoogleCloudVisionV1p4beta1BoundingPoly"
}
}
},
"GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": {
"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": "GoogleCloudVisionV1p3beta1Position"
}
},
"id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark",
"description": "A face-specific landmark (for example, a face feature).",
"type": "object"
},
"ImportProductSetsGcsSource": {
"id": "ImportProductSetsGcsSource",
"properties": {
"csvFileUri": {
"type": "string",
"description": "The Google Cloud Storage URI of the input csv file. The URI must start with `gs://`. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to display_name, the `product-category` column refers to product_category, and the `labels` column refers to product_labels. The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the display_name field for the product to a space (\" \"). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: \"key_1=value_1,key_2=value_2,...,key_n=value_n\" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format \"p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y\". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP)."
}
},
"description": "The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.",
"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": {
"type": "number",
"format": "float",
"description": "X coordinate."
},
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
},
"z": {
"type": "number",
"format": "float",
"description": "Z coordinate (or depth)."
}
},
"id": "GoogleCloudVisionV1p2beta1Position",
"type": "object"
},
"GoogleCloudVisionV1p3beta1ProductKeyValue": {
"properties": {
"value": {
"description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.",
"type": "string"
},
"key": {
"type": "string",
"description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes."
}
},
"type": "object",
"id": "GoogleCloudVisionV1p3beta1ProductKeyValue",
"description": "A product label represented as a key-value pair."
},
"GoogleCloudVisionV1p1beta1GcsSource": {
"description": "The Google Cloud Storage location where the input will be read from.",
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported."
}
},
"id": "GoogleCloudVisionV1p1beta1GcsSource"
},
"GoogleCloudVisionV1p3beta1DominantColorsAnnotation": {
"id": "GoogleCloudVisionV1p3beta1DominantColorsAnnotation",
"type": "object",
"description": "Set of dominant colors and their corresponding scores.",
"properties": {
"colors": {
"description": "RGB color values with their score and pixel fraction.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ColorInfo"
},
"type": "array"
}
}
},
"GoogleCloudVisionV1p4beta1ImageProperties": {
"id": "GoogleCloudVisionV1p4beta1ImageProperties",
"description": "Stores image properties, such as dominant colors.",
"properties": {
"dominantColors": {
"$ref": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation",
"description": "If present, dominant colors completed successfully."
}
},
"type": "object"
},
"Vertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"properties": {
"y": {
"description": "Y coordinate.",
"format": "int32",
"type": "integer"
},
"x": {
"format": "int32",
"type": "integer",
"description": "X coordinate."
}
},
"type": "object",
"id": "Vertex"
},
"GoogleCloudVisionV1p4beta1WebDetectionWebLabel": {
"id": "GoogleCloudVisionV1p4beta1WebDetectionWebLabel",
"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."
}
},
"type": "object",
"description": "Label to provide extra metadata for the web detection."
},
"ImportProductSetsResponse": {
"properties": {
"statuses": {
"description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.",
"type": "array",
"items": {
"$ref": "Status"
}
},
"referenceImages": {
"items": {
"$ref": "ReferenceImage"
},
"description": "The list of reference_images that are imported successfully.",
"type": "array"
}
},
"type": "object",
"description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.",
"id": "ImportProductSetsResponse"
},
"GoogleCloudVisionV1p4beta1AnnotateFileResponse": {
"id": "GoogleCloudVisionV1p4beta1AnnotateFileResponse",
"properties": {
"responses": {
"type": "array",
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1AnnotateImageResponse"
}
},
"totalPages": {
"format": "int32",
"type": "integer",
"description": "This field gives the total number of pages in the file."
},
"error": {
"$ref": "Status",
"description": "If set, represents the error message for the failed request. The `responses` field will not be set in this case."
},
"inputConfig": {
"$ref": "GoogleCloudVisionV1p4beta1InputConfig",
"description": "Information about the file for which this response is generated."
}
},
"type": "object",
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses."
},
"GoogleCloudVisionV1p1beta1CropHintsAnnotation": {
"id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation",
"description": "Set of crop hints that are used to generate new crops when serving images.",
"properties": {
"cropHints": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1CropHint"
},
"type": "array",
"description": "Crop hint results."
}
},
"type": "object"
},
"GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage": {
"type": "object",
"properties": {
"confidence": {
"format": "float",
"type": "number",
"description": "Confidence of detected language. Range [0, 1]."
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
}
},
"description": "Detected language for a structural component.",
"id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedLanguage"
},
"CancelOperationRequest": {
"properties": {},
"id": "CancelOperationRequest",
"type": "object",
"description": "The request message for Operations.CancelOperation."
},
"GoogleCloudVisionV1p2beta1TextAnnotation": {
"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": "GoogleCloudVisionV1p2beta1Page"
}
},
"text": {
"description": "UTF-8 text detected on the pages.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p2beta1TextAnnotation"
},
"GoogleCloudVisionV1p2beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudVisionV1p2beta1BoundingPoly",
"type": "object",
"properties": {
"normalizedVertices": {
"type": "array",
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1NormalizedVertex"
}
},
"vertices": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1Vertex"
},
"type": "array",
"description": "The bounding polygon vertices."
}
}
},
"GoogleCloudVisionV1p2beta1Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"properties": {
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
"type": "string"
},
"value": {
"type": "string",
"description": "Value of the property."
},
"name": {
"type": "string",
"description": "Name of the property."
}
},
"type": "object",
"id": "GoogleCloudVisionV1p2beta1Property"
},
"GoogleCloudVisionV1p2beta1Paragraph": {
"description": "Structural unit of text representing a number of words in certain order.",
"id": "GoogleCloudVisionV1p2beta1Paragraph",
"properties": {
"confidence": {
"type": "number",
"format": "float",
"description": "Confidence of the OCR results for the paragraph. Range [0, 1]."
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"property": {
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty",
"description": "Additional information detected for the paragraph."
},
"words": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1Word"
},
"description": "List of all words in this paragraph.",
"type": "array"
}
},
"type": "object"
},
"Symbol": {
"type": "object",
"id": "Symbol",
"properties": {
"text": {
"type": "string",
"description": "The actual UTF-8 representation of the symbol."
},
"boundingBox": {
"description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).",
"$ref": "BoundingPoly"
},
"property": {
"$ref": "TextProperty",
"description": "Additional information detected for the symbol."
},
"confidence": {
"format": "float",
"description": "Confidence of the OCR results for the symbol. Range [0, 1].",
"type": "number"
}
},
"description": "A single symbol representation."
},
"GoogleCloudVisionV1p4beta1SafeSearchAnnotation": {
"properties": {
"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.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"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"
},
"violence": {
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Likelihood that this image contains violent content.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"medical": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Likelihood that this is a medical image.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"racy": {
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas."
}
},
"id": "GoogleCloudVisionV1p4beta1SafeSearchAnnotation",
"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"
},
"GoogleCloudVisionV1p4beta1LocationInfo": {
"description": "Detected entity location information.",
"type": "object",
"properties": {
"latLng": {
"$ref": "LatLng",
"description": "lat/long location coordinates."
}
},
"id": "GoogleCloudVisionV1p4beta1LocationInfo"
},
"GoogleCloudVisionV1p4beta1Paragraph": {
"properties": {
"boundingBox": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"words": {
"items": {
"$ref": "GoogleCloudVisionV1p4beta1Word"
},
"description": "List of all words in this paragraph.",
"type": "array"
},
"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": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty"
}
},
"description": "Structural unit of text representing a number of words in certain order.",
"id": "GoogleCloudVisionV1p4beta1Paragraph",
"type": "object"
},
"GoogleCloudVisionV1p3beta1Property": {
"type": "object",
"properties": {
"name": {
"description": "Name of the property.",
"type": "string"
},
"value": {
"description": "Value of the property.",
"type": "string"
},
"uint64Value": {
"format": "uint64",
"description": "Value of numeric properties.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p3beta1Property",
"description": "A `Property` consists of a user-supplied name/value pair."
},
"GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse": {
"description": "The response for a single offline file annotation request.",
"type": "object",
"id": "GoogleCloudVisionV1p2beta1AsyncAnnotateFileResponse",
"properties": {
"outputConfig": {
"description": "The output location and metadata from AsyncAnnotateFileRequest.",
"$ref": "GoogleCloudVisionV1p2beta1OutputConfig"
}
}
},
"GoogleCloudVisionV1p2beta1CropHintsAnnotation": {
"type": "object",
"id": "GoogleCloudVisionV1p2beta1CropHintsAnnotation",
"properties": {
"cropHints": {
"description": "Crop hint results.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1CropHint"
}
}
},
"description": "Set of crop hints that are used to generate new crops when serving images."
},
"GoogleCloudVisionV1p2beta1WebDetectionWebLabel": {
"id": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel",
"type": "object",
"description": "Label to provide extra metadata for the web detection.",
"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"
}
}
},
"GoogleCloudVisionV1p4beta1DominantColorsAnnotation": {
"properties": {
"colors": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ColorInfo"
},
"description": "RGB color values with their score and pixel fraction."
}
},
"id": "GoogleCloudVisionV1p4beta1DominantColorsAnnotation",
"description": "Set of dominant colors and their corresponding scores.",
"type": "object"
},
"Operation": {
"id": "Operation",
"type": "object",
"description": "This resource represents a long-running operation that is the result of a network API call.",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"response": {
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"metadata": {
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
}
}
},
"GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak": {
"type": "object",
"description": "Detected start or end of a structural component.",
"properties": {
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
},
"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 break type.",
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
]
}
},
"id": "GoogleCloudVisionV1p2beta1TextAnnotationDetectedBreak"
},
"GoogleCloudVisionV1p2beta1GcsSource": {
"id": "GoogleCloudVisionV1p2beta1GcsSource",
"description": "The Google Cloud Storage location where the input will be read from.",
"type": "object",
"properties": {
"uri": {
"description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p1beta1AnnotateImageResponse": {
"id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse",
"description": "Response to an image annotation request.",
"type": "object",
"properties": {
"logoAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"description": "If present, logo detection has completed successfully."
},
"localizedObjectAnnotations": {
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation"
},
"type": "array"
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"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"
},
"context": {
"description": "If present, contextual information is needed to understand where this image comes from.",
"$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext"
},
"cropHintsAnnotation": {
"description": "If present, crop hints have completed successfully.",
"$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
},
"safeSearchAnnotation": {
"description": "If present, safe-search annotation has completed successfully.",
"$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
},
"webDetection": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetection",
"description": "If present, web 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"
},
"textAnnotations": {
"description": "If present, text (OCR) detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"productSearchResults": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResults",
"description": "If present, product search has completed successfully."
},
"imagePropertiesAnnotation": {
"description": "If present, image properties were extracted successfully.",
"$ref": "GoogleCloudVisionV1p1beta1ImageProperties"
},
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
}
},
"faceAnnotations": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation"
},
"description": "If present, face detection has completed successfully."
}
}
},
"GoogleCloudVisionV1p1beta1WebDetection": {
"description": "Relevant information for the image from the Internet.",
"properties": {
"fullMatchingImages": {
"description": "Fully matching images from the Internet. Can include resized copies of the query image.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
}
},
"bestGuessLabels": {
"description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel"
},
"type": "array"
},
"pagesWithMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage"
},
"type": "array",
"description": "Web pages containing the matching images from the Internet."
},
"partialMatchingImages": {
"type": "array",
"description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
}
},
"webEntities": {
"description": "Deduced entities from similar images on the Internet.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity"
}
},
"visuallySimilarImages": {
"type": "array",
"description": "The visually similar image results.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
}
}
},
"type": "object",
"id": "GoogleCloudVisionV1p1beta1WebDetection"
},
"GoogleCloudVisionV1p1beta1DominantColorsAnnotation": {
"properties": {
"colors": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ColorInfo"
},
"description": "RGB color values with their score and pixel fraction.",
"type": "array"
}
},
"type": "object",
"description": "Set of dominant colors and their corresponding scores.",
"id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"operations": {
"items": {
"$ref": "Operation"
},
"type": "array",
"description": "A list of operations that matches the specified filter in the request."
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"id": "ListOperationsResponse"
},
"LatLongRect": {
"properties": {
"minLatLng": {
"$ref": "LatLng",
"description": "Min lat/long pair."
},
"maxLatLng": {
"$ref": "LatLng",
"description": "Max lat/long pair."
}
},
"description": "Rectangle determined by min and max `LatLng` pairs.",
"type": "object",
"id": "LatLongRect"
},
"GoogleCloudVisionV1p3beta1WebDetection": {
"properties": {
"fullMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage"
},
"type": "array",
"description": "Fully matching images from the Internet. Can include resized copies of the query image."
},
"partialMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage"
},
"type": "array",
"description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops."
},
"webEntities": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebEntity"
},
"type": "array",
"description": "Deduced entities from similar images on the Internet."
},
"visuallySimilarImages": {
"description": "The visually similar image results.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage"
}
},
"pagesWithMatchingImages": {
"type": "array",
"description": "Web pages containing the matching images from the Internet.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebPage"
}
},
"bestGuessLabels": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel"
},
"description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.",
"type": "array"
}
},
"description": "Relevant information for the image from the Internet.",
"type": "object",
"id": "GoogleCloudVisionV1p3beta1WebDetection"
},
"GoogleCloudVisionV1p4beta1ImportProductSetsResponse": {
"type": "object",
"id": "GoogleCloudVisionV1p4beta1ImportProductSetsResponse",
"description": "Response message for the `ImportProductSets` method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.",
"properties": {
"referenceImages": {
"description": "The list of reference_images that are imported successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1ReferenceImage"
},
"type": "array"
},
"statuses": {
"items": {
"$ref": "Status"
},
"description": "The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.",
"type": "array"
}
}
},
"GoogleCloudVisionV1p1beta1Position": {
"id": "GoogleCloudVisionV1p1beta1Position",
"type": "object",
"properties": {
"y": {
"type": "number",
"format": "float",
"description": "Y coordinate."
},
"z": {
"description": "Z coordinate (or depth).",
"type": "number",
"format": "float"
},
"x": {
"description": "X coordinate.",
"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."
},
"GoogleCloudVisionV1p3beta1Product": {
"properties": {
"description": {
"type": "string",
"description": "User-provided metadata to be stored with this product. 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"
},
"displayName": {
"type": "string",
"description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long."
},
"productLabels": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ProductKeyValue"
},
"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": "GoogleCloudVisionV1p3beta1Product"
},
"ReferenceImage": {
"type": "object",
"id": "ReferenceImage",
"properties": {
"uri": {
"type": "string",
"description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`."
},
"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."
},
"boundingPolys": {
"type": "array",
"items": {
"$ref": "BoundingPoly"
},
"description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not)."
}
},
"description": "A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes."
},
"GoogleCloudVisionV1p3beta1WebDetectionWebLabel": {
"id": "GoogleCloudVisionV1p3beta1WebDetectionWebLabel",
"properties": {
"languageCode": {
"type": "string",
"description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
},
"label": {
"description": "Label for extra metadata.",
"type": "string"
}
},
"type": "object",
"description": "Label to provide extra metadata for the web detection."
},
"GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation": {
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly",
"description": "Image region to which this object belongs. This must be populated."
},
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"score": {
"description": "Score of the result. Range [0, 1].",
"format": "float",
"type": "number"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p4beta1LocalizedObjectAnnotation",
"type": "object",
"description": "Set of detected objects with bounding boxes."
},
"LocalizedObjectAnnotation": {
"type": "object",
"id": "LocalizedObjectAnnotation",
"properties": {
"mid": {
"type": "string",
"description": "Object ID that should align with EntityAnnotation mid."
},
"boundingPoly": {
"$ref": "BoundingPoly",
"description": "Image region to which this object belongs. This must be populated."
},
"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": "Set of detected objects with bounding boxes."
},
"RemoveProductFromProductSetRequest": {
"type": "object",
"description": "Request message for the `RemoveProductFromProductSet` method.",
"id": "RemoveProductFromProductSetRequest",
"properties": {
"product": {
"description": "Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`",
"type": "string"
}
}
},
"GoogleCloudVisionV1p3beta1ProductSearchResultsResult": {
"id": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult",
"description": "Information about a product.",
"properties": {
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
},
"score": {
"type": "number",
"description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).",
"format": "float"
},
"product": {
"$ref": "GoogleCloudVisionV1p3beta1Product",
"description": "The Product."
}
},
"type": "object"
},
"BatchAnnotateImagesRequest": {
"id": "BatchAnnotateImagesRequest",
"description": "Multiple image annotation requests are batched into a single service call.",
"type": "object",
"properties": {
"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`."
},
"requests": {
"items": {
"$ref": "AnnotateImageRequest"
},
"description": "Required. Individual image annotation requests for this batch.",
"type": "array"
}
}
},
"GoogleCloudVisionV1p4beta1Property": {
"properties": {
"value": {
"type": "string",
"description": "Value of the property."
},
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
"type": "string"
},
"name": {
"description": "Name of the property.",
"type": "string"
}
},
"type": "object",
"id": "GoogleCloudVisionV1p4beta1Property",
"description": "A `Property` consists of a user-supplied name/value pair."
},
"GoogleCloudVisionV1p4beta1Symbol": {
"description": "A single symbol representation.",
"properties": {
"confidence": {
"format": "float",
"description": "Confidence of the OCR results for the symbol. Range [0, 1].",
"type": "number"
},
"text": {
"type": "string",
"description": "The actual UTF-8 representation of the symbol."
},
"boundingBox": {
"description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).",
"$ref": "GoogleCloudVisionV1p4beta1BoundingPoly"
},
"property": {
"$ref": "GoogleCloudVisionV1p4beta1TextAnnotationTextProperty",
"description": "Additional information detected for the symbol."
}
},
"id": "GoogleCloudVisionV1p4beta1Symbol",
"type": "object"
},
"GoogleCloudVisionV1p4beta1BatchOperationMetadata": {
"description": "Metadata for the batch operations such as the current state. This is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.",
"type": "object",
"properties": {
"submitTime": {
"description": "The time when the batch request was submitted to the server.",
"type": "string",
"format": "google-datetime"
},
"endTime": {
"format": "google-datetime",
"description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.",
"type": "string"
},
"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."
]
}
},
"id": "GoogleCloudVisionV1p4beta1BatchOperationMetadata"
},
"GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse": {
"type": "object",
"properties": {
"responses": {
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1AsyncAnnotateFileResponse"
}
}
},
"description": "Response to an async batch file annotation request.",
"id": "GoogleCloudVisionV1p4beta1AsyncBatchAnnotateFilesResponse"
},
"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": {
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
"type": "number",
"format": "float"
},
"pixelFraction": {
"description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].",
"format": "float",
"type": "number"
},
"color": {
"$ref": "Color",
"description": "RGB components of the color."
}
}
},
"GoogleCloudVisionV1p3beta1Paragraph": {
"type": "object",
"description": "Structural unit of text representing a number of words in certain order.",
"id": "GoogleCloudVisionV1p3beta1Paragraph",
"properties": {
"words": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Word"
},
"description": "List of all words in this paragraph."
},
"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"
},
"confidence": {
"format": "float",
"description": "Confidence of the OCR results for the paragraph. Range [0, 1].",
"type": "number"
},
"property": {
"description": "Additional information detected for the paragraph.",
"$ref": "GoogleCloudVisionV1p3beta1TextAnnotationTextProperty"
}
}
},
"GoogleCloudVisionV1p3beta1EntityAnnotation": {
"description": "Set of detected entity features.",
"properties": {
"score": {
"type": "number",
"format": "float",
"description": "Overall score of the result. Range [0, 1]."
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly",
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features."
},
"topicality": {
"type": "number",
"format": "float",
"description": "The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of \"tower\" is likely higher to an image containing the detected \"Eiffel Tower\" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1]."
},
"mid": {
"type": "string",
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)."
},
"properties": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1Property"
},
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity."
},
"locale": {
"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"
},
"confidence": {
"type": "number",
"description": "**Deprecated. Use `score` instead.** The accuracy of the entity detection in an image. For example, for an image in which the \"Eiffel Tower\" entity is detected, this field represents the confidence that there is a tower in the query image. Range [0, 1].",
"format": "float"
},
"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": "GoogleCloudVisionV1p3beta1LocationInfo"
}
}
},
"type": "object",
"id": "GoogleCloudVisionV1p3beta1EntityAnnotation"
},
"AnnotateFileRequest": {
"id": "AnnotateFileRequest",
"description": "A request to annotate one single file, e.g. a PDF, TIFF or GIF file.",
"properties": {
"features": {
"type": "array",
"items": {
"$ref": "Feature"
},
"description": "Required. Requested features."
},
"imageContext": {
"$ref": "ImageContext",
"description": "Additional context that may accompany the image(s) in the file."
},
"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"
}
},
"inputConfig": {
"description": "Required. Information about the input file.",
"$ref": "InputConfig"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Product": {
"id": "GoogleCloudVisionV1p1beta1Product",
"properties": {
"displayName": {
"description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.",
"type": "string"
},
"name": {
"type": "string",
"description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product."
},
"description": {
"description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.",
"type": "string"
},
"productLabels": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue"
},
"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.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1LocationInfo": {
"properties": {
"latLng": {
"description": "lat/long location coordinates.",
"$ref": "LatLng"
}
},
"description": "Detected entity location information.",
"type": "object",
"id": "GoogleCloudVisionV1p1beta1LocationInfo"
},
"GoogleCloudVisionV1p1beta1Block": {
"properties": {
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"type": "number",
"format": "float"
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"blockType": {
"type": "string",
"enum": [
"UNKNOWN",
"TEXT",
"TABLE",
"PICTURE",
"RULER",
"BARCODE"
],
"enumDescriptions": [
"Unknown block type.",
"Regular text block.",
"Table block.",
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
],
"description": "Detected block type (text, image etc) for this block."
},
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected for the block."
},
"paragraphs": {
"type": "array",
"description": "List of paragraphs in this block (if this blocks is of type text).",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Paragraph"
}
}
},
"type": "object",
"id": "GoogleCloudVisionV1p1beta1Block",
"description": "Logical element on the page."
},
"FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"properties": {
"fdBoundingPoly": {
"$ref": "BoundingPoly",
"description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix."
},
"boundingPoly": {
"$ref": "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."
},
"sorrowLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"description": "Sorrow likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"blurredLikelihood": {
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Blurred likelihood."
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"rollAngle": {
"format": "float",
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].",
"type": "number"
},
"landmarks": {
"type": "array",
"items": {
"$ref": "Landmark"
},
"description": "Detected face landmarks."
},
"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].",
"type": "number",
"format": "float"
},
"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."
],
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"joyLikelihood": {
"description": "Joy likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"headwearLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"description": "Headwear likelihood."
},
"landmarkingConfidence": {
"description": "Face landmarking confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"surpriseLikelihood": {
"description": "Surprise likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
},
"angerLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"description": "Anger likelihood.",
"type": "string"
},
"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].",
"type": "number",
"format": "float"
}
},
"id": "FaceAnnotation",
"type": "object"
},
"GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation": {
"type": "object",
"properties": {
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"score": {
"description": "Score of the result. Range [0, 1].",
"type": "number",
"format": "float"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
}
},
"id": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation",
"description": "Prediction for what the object in the bounding box is."
},
"GoogleCloudVisionV1p2beta1Vertex": {
"type": "object",
"id": "GoogleCloudVisionV1p2beta1Vertex",
"properties": {
"x": {
"description": "X coordinate.",
"type": "integer",
"format": "int32"
},
"y": {
"description": "Y coordinate.",
"type": "integer",
"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."
},
"GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
"properties": {
"violence": {
"type": "string",
"description": "Likelihood that this image contains violent content.",
"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": {
"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": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas."
},
"medical": {
"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"
},
"spoof": {
"description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"adult": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.",
"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": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
},
"GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse": {
"id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse",
"description": "The response for a single offline file annotation request.",
"properties": {
"outputConfig": {
"$ref": "GoogleCloudVisionV1p1beta1OutputConfig",
"description": "The output location and metadata from AsyncAnnotateFileRequest."
}
},
"type": "object"
},
"GoogleCloudVisionV1p4beta1WebDetectionWebEntity": {
"id": "GoogleCloudVisionV1p4beta1WebDetectionWebEntity",
"properties": {
"score": {
"description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries.",
"type": "number",
"format": "float"
},
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
},
"entityId": {
"description": "Opaque entity ID.",
"type": "string"
}
},
"description": "Entity deduced from similar images on the Internet.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": {
"description": "Detected start or end of a structural component.",
"type": "object",
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak",
"properties": {
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
},
"type": {
"description": "Detected break type.",
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
"Sure space (very wide).",
"Line-wrapping break.",
"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
"Line break that ends a paragraph."
],
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
],
"type": "string"
}
}
},
"GoogleCloudVisionV1p2beta1SafeSearchAnnotation": {
"properties": {
"spoof": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.",
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"adult": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.",
"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"
},
"violence": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Likelihood that this image contains violent content.",
"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."
]
}
},
"id": "GoogleCloudVisionV1p2beta1SafeSearchAnnotation",
"type": "object",
"description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence)."
},
"TextProperty": {
"description": "Additional information detected on the structural component.",
"id": "TextProperty",
"type": "object",
"properties": {
"detectedBreak": {
"description": "Detected start or end of a text segment.",
"$ref": "DetectedBreak"
},
"detectedLanguages": {
"items": {
"$ref": "DetectedLanguage"
},
"type": "array",
"description": "A list of detected languages together with confidence."
}
}
},
"GoogleCloudVisionV1p1beta1WebDetectionWebPage": {
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage",
"properties": {
"fullMatchingImages": {
"description": "Fully matching images on the page. Can include resized copies of the query image.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
},
"type": "array"
},
"url": {
"description": "The result web page URL.",
"type": "string"
},
"pageTitle": {
"description": "Title for the web page, may contain HTML markups.",
"type": "string"
},
"score": {
"format": "float",
"type": "number",
"description": "(Deprecated) Overall relevancy score for the web page."
},
"partialMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
},
"type": "array",
"description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops."
}
},
"description": "Metadata for web pages.",
"type": "object"
},
"GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": {
"type": "object",
"properties": {
"objectAnnotations": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation"
},
"type": "array",
"description": "List of generic predictions for the object in the bounding box."
},
"boundingPoly": {
"description": "The bounding polygon around the product detected in the query image.",
"$ref": "GoogleCloudVisionV1p3beta1BoundingPoly"
},
"results": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult"
},
"type": "array",
"description": "List of results, one for each product match."
}
},
"description": "Information about the products similar to a single product in a query image.",
"id": "GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult"
},
"AsyncBatchAnnotateImagesResponse": {
"id": "AsyncBatchAnnotateImagesResponse",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "The output location and metadata from AsyncBatchAnnotateImagesRequest."
}
},
"type": "object",
"description": "Response to an async batch image annotation request."
},
"ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"properties": {
"score": {
"type": "number",
"format": "float",
"description": "Image-specific score for this color. Value in range [0, 1]."
},
"pixelFraction": {
"format": "float",
"type": "number",
"description": "The fraction of pixels the color occupies in the image. Value in range [0, 1]."
},
"color": {
"$ref": "Color",
"description": "RGB components of the color."
}
},
"type": "object",
"id": "ColorInfo"
},
"GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak": {
"description": "Detected start or end of a structural component.",
"id": "GoogleCloudVisionV1p4beta1TextAnnotationDetectedBreak",
"properties": {
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
},
"type": {
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
"Sure space (very wide).",
"Line-wrapping break.",
"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
"Line break that ends a paragraph."
],
"type": "string",
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
],
"description": "Detected break type."
}
},
"type": "object"
},
"GoogleCloudVisionV1p4beta1Celebrity": {
"id": "GoogleCloudVisionV1p4beta1Celebrity",
"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}`."
},
"description": {
"type": "string",
"description": "The Celebrity's description."
},
"displayName": {
"description": "The Celebrity's display name.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p2beta1WebDetectionWebEntity": {
"properties": {
"entityId": {
"type": "string",
"description": "Opaque entity ID."
},
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
},
"score": {
"type": "number",
"format": "float",
"description": "Overall relevancy score for the entity. Not normalized and not comparable across different image queries."
}
},
"type": "object",
"description": "Entity deduced from similar images on the Internet.",
"id": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity"
},
"GoogleCloudVisionV1p3beta1ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"id": "GoogleCloudVisionV1p3beta1ColorInfo",
"properties": {
"score": {
"format": "float",
"description": "Image-specific score for this color. Value in range [0, 1].",
"type": "number"
},
"pixelFraction": {
"type": "number",
"description": "The fraction of pixels the color occupies in the image. Value in range [0, 1].",
"format": "float"
},
"color": {
"description": "RGB components of the color.",
"$ref": "Color"
}
},
"type": "object"
},
"GoogleCloudVisionV1p2beta1Symbol": {
"id": "GoogleCloudVisionV1p2beta1Symbol",
"description": "A single symbol representation.",
"type": "object",
"properties": {
"property": {
"description": "Additional information detected for the symbol.",
"$ref": "GoogleCloudVisionV1p2beta1TextAnnotationTextProperty"
},
"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].",
"type": "number",
"format": "float"
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p2beta1BoundingPoly",
"description": "The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
}
}
},
"AsyncBatchAnnotateFilesRequest": {
"type": "object",
"description": "Multiple async file annotation requests are batched into a single service call.",
"id": "AsyncBatchAnnotateFilesRequest",
"properties": {
"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`."
},
"requests": {
"items": {
"$ref": "AsyncAnnotateFileRequest"
},
"type": "array",
"description": "Required. Individual async file annotation requests for this batch."
}
}
},
"GoogleCloudVisionV1p2beta1OutputConfig": {
"properties": {
"gcsDestination": {
"$ref": "GoogleCloudVisionV1p2beta1GcsDestination",
"description": "The Google Cloud Storage location to write the output(s) to."
},
"batchSize": {
"type": "integer",
"format": "int32",
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations."
}
},
"id": "GoogleCloudVisionV1p2beta1OutputConfig",
"description": "The desired output location and metadata.",
"type": "object"
},
"GoogleCloudVisionV1p1beta1Vertex": {
"description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.",
"id": "GoogleCloudVisionV1p1beta1Vertex",
"type": "object",
"properties": {
"y": {
"type": "integer",
"description": "Y coordinate.",
"format": "int32"
},
"x": {
"type": "integer",
"description": "X coordinate.",
"format": "int32"
}
}
},
"GoogleCloudVisionV1p1beta1FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"id": "GoogleCloudVisionV1p1beta1FaceAnnotation",
"type": "object",
"properties": {
"landmarks": {
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
},
"description": "Detected face landmarks."
},
"headwearLikelihood": {
"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",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
"type": "number",
"format": "float"
},
"underExposedLikelihood": {
"description": "Under-exposed likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"angerLikelihood": {
"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",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"joyLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string",
"description": "Joy likelihood."
},
"surpriseLikelihood": {
"description": "Surprise likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"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"
},
"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"
},
"landmarkingConfidence": {
"format": "float",
"description": "Face landmarking confidence. Range [0, 1].",
"type": "number"
},
"sorrowLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Sorrow likelihood.",
"type": "string"
},
"panAngle": {
"type": "number",
"format": "float",
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180]."
},
"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].",
"type": "number",
"format": "float"
},
"blurredLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string",
"description": "Blurred likelihood."
},
"rollAngle": {
"format": "float",
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].",
"type": "number"
}
}
},
"GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse": {
"type": "object",
"properties": {
"responses": {
"type": "array",
"description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.",
"items": {
"$ref": "GoogleCloudVisionV1p4beta1AnnotateFileResponse"
}
}
},
"id": "GoogleCloudVisionV1p4beta1BatchAnnotateFilesResponse",
"description": "A list of file annotation responses."
},
"GoogleCloudVisionV1p3beta1ProductSearchResults": {
"properties": {
"results": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1ProductSearchResultsResult"
},
"description": "List of results, one for each product match.",
"type": "array"
},
"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"
}
},
"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"
}
},
"type": "object",
"description": "Results for a product search request.",
"id": "GoogleCloudVisionV1p3beta1ProductSearchResults"
},
"OutputConfig": {
"id": "OutputConfig",
"description": "The desired output location and metadata.",
"properties": {
"gcsDestination": {
"$ref": "GcsDestination",
"description": "The Google Cloud Storage location to write the output(s) to."
},
"batchSize": {
"type": "integer",
"format": "int32",
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations."
}
},
"type": "object"
},
"GoogleCloudVisionV1p3beta1SafeSearchAnnotation": {
"type": "object",
"id": "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": {
"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."
],
"type": "string",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
]
},
"adult": {
"description": "Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"medical": {
"description": "Likelihood that this is a medical image.",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string"
},
"racy": {
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"type": "string"
},
"violence": {
"type": "string",
"description": "Likelihood that this image contains violent content.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
]
}
}
},
"GoogleCloudVisionV1p3beta1ImageAnnotationContext": {
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.",
"type": "object",
"properties": {
"uri": {
"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.",
"type": "integer",
"format": "int32"
}
},
"id": "GoogleCloudVisionV1p3beta1ImageAnnotationContext"
},
"GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage": {
"type": "object",
"id": "GoogleCloudVisionV1p3beta1TextAnnotationDetectedLanguage",
"description": "Detected language for a structural component.",
"properties": {
"confidence": {
"type": "number",
"description": "Confidence of detected language. 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."
}
}
},
"GoogleCloudVisionV1p1beta1Paragraph": {
"description": "Structural unit of text representing a number of words in certain order.",
"type": "object",
"properties": {
"boundingBox": {
"description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).",
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
},
"words": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Word"
},
"description": "List of all words in this paragraph.",
"type": "array"
},
"property": {
"description": "Additional information detected for the paragraph.",
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
},
"confidence": {
"description": "Confidence of the OCR results for the paragraph. Range [0, 1].",
"format": "float",
"type": "number"
}
},
"id": "GoogleCloudVisionV1p1beta1Paragraph"
},
"NormalizedVertex": {
"type": "object",
"description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.",
"id": "NormalizedVertex",
"properties": {
"y": {
"description": "Y coordinate.",
"type": "number",
"format": "float"
},
"x": {
"format": "float",
"type": "number",
"description": "X coordinate."
}
}
},
"ObjectAnnotation": {
"description": "Prediction for what the object in the bounding box is.",
"type": "object",
"properties": {
"languageCode": {
"type": "string",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier."
},
"score": {
"type": "number",
"description": "Score of the result. Range [0, 1].",
"format": "float"
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
}
},
"id": "ObjectAnnotation"
},
"LatLng": {
"type": "object",
"id": "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 must conform to the WGS84 standard. Values must be within normalized ranges.",
"properties": {
"latitude": {
"format": "double",
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"type": "number"
},
"longitude": {
"type": "number",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double"
}
}
},
"GoogleCloudVisionV1p4beta1WebDetectionWebImage": {
"id": "GoogleCloudVisionV1p4beta1WebDetectionWebImage",
"type": "object",
"description": "Metadata for online images.",
"properties": {
"score": {
"description": "(Deprecated) Overall relevancy score for the image.",
"type": "number",
"format": "float"
},
"url": {
"description": "The result image URL.",
"type": "string"
}
}
},
"GoogleCloudVisionV1p2beta1Product": {
"description": "A Product contains ReferenceImages.",
"type": "object",
"id": "GoogleCloudVisionV1p2beta1Product",
"properties": {
"displayName": {
"type": "string",
"description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long."
},
"description": {
"description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.",
"type": "string"
},
"name": {
"description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.",
"type": "string"
},
"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": {
"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"
}
}
},
"CropHint": {
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"type": "object",
"id": "CropHint",
"properties": {
"importanceFraction": {
"description": "Fraction of importance of this salient region with respect to the original image.",
"format": "float",
"type": "number"
},
"confidence": {
"description": "Confidence of this being a salient region. Range [0, 1].",
"type": "number",
"format": "float"
},
"boundingPoly": {
"$ref": "BoundingPoly",
"description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale."
}
}
},
"GoogleCloudVisionV1p1beta1WebDetectionWebEntity": {
"description": "Entity deduced from similar images on the Internet.",
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity",
"type": "object",
"properties": {
"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.",
"type": "number",
"format": "float"
},
"entityId": {
"type": "string",
"description": "Opaque entity ID."
}
}
},
"GoogleCloudVisionV1p3beta1WebDetectionWebPage": {
"id": "GoogleCloudVisionV1p3beta1WebDetectionWebPage",
"description": "Metadata for web pages.",
"properties": {
"partialMatchingImages": {
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage"
},
"description": "Partial matching images on the page. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"type": "array"
},
"url": {
"description": "The result web page URL.",
"type": "string"
},
"score": {
"description": "(Deprecated) Overall relevancy score for the web page.",
"type": "number",
"format": "float"
},
"fullMatchingImages": {
"description": "Fully matching images on the page. Can include resized copies of the query image.",
"items": {
"$ref": "GoogleCloudVisionV1p3beta1WebDetectionWebImage"
},
"type": "array"
},
"pageTitle": {
"type": "string",
"description": "Title for the web page, may contain HTML markups."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": {
"type": "object",
"id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"properties": {
"detectedBreak": {
"description": "Detected start or end of a text segment.",
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak"
},
"detectedLanguages": {
"items": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
},
"type": "array",
"description": "A list of detected languages together with confidence."
}
},
"description": "Additional information detected on the structural component."
},
"GoogleCloudVisionV1p2beta1ProductSearchResults": {
"description": "Results for a product search request.",
"properties": {
"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"
}
},
"results": {
"type": "array",
"description": "List of results, one for each product match.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1ProductSearchResultsResult"
}
},
"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"
}
},
"id": "GoogleCloudVisionV1p2beta1ProductSearchResults",
"type": "object"
},
"GoogleCloudVisionV1p1beta1OutputConfig": {
"id": "GoogleCloudVisionV1p1beta1OutputConfig",
"type": "object",
"properties": {
"batchSize": {
"type": "integer",
"format": "int32",
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations."
},
"gcsDestination": {
"$ref": "GoogleCloudVisionV1p1beta1GcsDestination",
"description": "The Google Cloud Storage location to write the output(s) to."
}
},
"description": "The desired output location and metadata."
},
"GoogleCloudVisionV1p4beta1GcsSource": {
"id": "GoogleCloudVisionV1p4beta1GcsSource",
"properties": {
"uri": {
"description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.",
"type": "string"
}
},
"type": "object",
"description": "The Google Cloud Storage location where the input will be read from."
},
"ProductSet": {
"id": "ProductSet",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long."
},
"indexError": {
"readOnly": true,
"$ref": "Status",
"description": "Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet."
},
"name": {
"type": "string",
"description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet."
},
"indexTime": {
"description": "Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value \"1970-01-01T00:00:00Z\". This field is ignored when creating a ProductSet.",
"type": "string",
"readOnly": true,
"format": "google-datetime"
}
},
"description": "A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail."
},
"KeyValue": {
"properties": {
"value": {
"description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.",
"type": "string"
},
"key": {
"type": "string",
"description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes."
}
},
"description": "A product label represented as a key-value pair.",
"type": "object",
"id": "KeyValue"
},
"GoogleCloudVisionV1p2beta1WebDetection": {
"type": "object",
"id": "GoogleCloudVisionV1p2beta1WebDetection",
"description": "Relevant information for the image from the Internet.",
"properties": {
"partialMatchingImages": {
"description": "Partial matching images from the Internet. Those images are similar enough to share some key-point features. For example an original image will likely have partial matching for its crops.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage"
},
"type": "array"
},
"visuallySimilarImages": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage"
},
"type": "array",
"description": "The visually similar image results."
},
"pagesWithMatchingImages": {
"description": "Web pages containing the matching images from the Internet.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebPage"
}
},
"fullMatchingImages": {
"type": "array",
"description": "Fully matching images from the Internet. Can include resized copies of the query image.",
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebImage"
}
},
"bestGuessLabels": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebLabel"
},
"description": "The service's best guess as to the topic of the request image. Inferred from similar images on the open web.",
"type": "array"
},
"webEntities": {
"items": {
"$ref": "GoogleCloudVisionV1p2beta1WebDetectionWebEntity"
},
"type": "array",
"description": "Deduced entities from similar images on the Internet."
}
}
},
"ImageSource": {
"description": "External image source (Google Cloud Storage or web URL image location).",
"id": "ImageSource",
"type": "object",
"properties": {
"imageUri": {
"description": "The URI of the source image. Can be either: 1. A Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DOS prevention), or if Google throttles requests to the site for abuse prevention. You should not depend on externally-hosted images for production applications. When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes precedence.",
"type": "string"
},
"gcsImageUri": {
"description": "**Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.",
"type": "string"
}
}
},
"Landmark": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Face landmark type.",
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
"RIGHT_EYE",
"LEFT_OF_LEFT_EYEBROW",
"RIGHT_OF_LEFT_EYEBROW",
"LEFT_OF_RIGHT_EYEBROW",
"RIGHT_OF_RIGHT_EYEBROW",
"MIDPOINT_BETWEEN_EYES",
"NOSE_TIP",
"UPPER_LIP",
"LOWER_LIP",
"MOUTH_LEFT",
"MOUTH_RIGHT",
"MOUTH_CENTER",
"NOSE_BOTTOM_RIGHT",
"NOSE_BOTTOM_LEFT",
"NOSE_BOTTOM_CENTER",
"LEFT_EYE_TOP_BOUNDARY",
"LEFT_EYE_RIGHT_CORNER",
"LEFT_EYE_BOTTOM_BOUNDARY",
"LEFT_EYE_LEFT_CORNER",
"RIGHT_EYE_TOP_BOUNDARY",
"RIGHT_EYE_RIGHT_CORNER",
"RIGHT_EYE_BOTTOM_BOUNDARY",
"RIGHT_EYE_LEFT_CORNER",
"LEFT_EYEBROW_UPPER_MIDPOINT",
"RIGHT_EYEBROW_UPPER_MIDPOINT",
"LEFT_EAR_TRAGION",
"RIGHT_EAR_TRAGION",
"LEFT_EYE_PUPIL",
"RIGHT_EYE_PUPIL",
"FOREHEAD_GLABELLA",
"CHIN_GNATHION",
"CHIN_LEFT_GONION",
"CHIN_RIGHT_GONION",
"LEFT_CHEEK_CENTER",
"RIGHT_CHEEK_CENTER"
],
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
"Left eye.",
"Right eye.",
"Left of left eyebrow.",
"Right of left eyebrow.",
"Left of right eyebrow.",
"Right of right eyebrow.",
"Midpoint between eyes.",
"Nose tip.",
"Upper lip.",
"Lower lip.",
"Mouth left.",
"Mouth right.",
"Mouth center.",
"Nose, bottom right.",
"Nose, bottom left.",
"Nose, bottom center.",
"Left eye, top boundary.",
"Left eye, right corner.",
"Left eye, bottom boundary.",
"Left eye, left corner.",
"Right eye, top boundary.",
"Right eye, right corner.",
"Right eye, bottom boundary.",
"Right eye, left corner.",
"Left eyebrow, upper midpoint.",
"Right eyebrow, upper midpoint.",
"Left ear tragion.",
"Right ear tragion.",
"Left eye pupil.",
"Right eye pupil.",
"Forehead glabella.",
"Chin gnathion.",
"Chin left gonion.",
"Chin right gonion.",
"Left cheek center.",
"Right cheek center."
]
},
"position": {
"description": "Face landmark position.",
"$ref": "Position"
}
},
"description": "A face-specific landmark (for example, a face feature).",
"id": "Landmark"
},
"GoogleCloudVisionV1p4beta1AsyncBatchAnnotateImagesResponse": {
"id": "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": "vision:v1",
"documentationLink": "https://cloud.google.com/vision/",
"name": "vision",
"basePath": "",
"version": "v1",
"baseUrl": "https://vision.googleapis.com/",
"mtlsRootUrl": "https://vision.mtls.googleapis.com/",
"version_module": true,
"revision": "20201023",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"rootUrl": "https://vision.googleapis.com/",
"parameters": {
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"fields": {
"location": "query",
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"upload_protocol": {
"location": "query",
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"oauth_token": {
"type": "string",
"location": "query",
"description": "OAuth 2.0 token for the current user."
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean",
"default": "true"
},
"alt": {
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query"
},
"$.xgafv": {
"location": "query",
"description": "V1 error format.",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"type": "string",
"enum": [
"1",
"2"
]
}
},
"discoveryVersion": "v1",
"servicePath": "",
"canonicalName": "Vision",
"description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
"kind": "discovery#restDescription",
"batchPath": "batch",
"ownerName": "Google",
"resources": {
"files": {
"methods": {
"asyncBatchAnnotate": {
"response": {
"$ref": "Operation"
},
"id": "vision.files.asyncBatchAnnotate",
"httpMethod": "POST",
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {},
"parameterOrder": [],
"flatPath": "v1/files:asyncBatchAnnotate",
"description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).",
"path": "v1/files:asyncBatchAnnotate"
},
"annotate": {
"httpMethod": "POST",
"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.",
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"flatPath": "v1/files:annotate",
"id": "vision.files.annotate",
"path": "v1/files:annotate",
"parameterOrder": [],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {}
}
}
},
"images": {
"methods": {
"asyncBatchAnnotate": {
"request": {
"$ref": "AsyncBatchAnnotateImagesRequest"
},
"description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"path": "v1/images:asyncBatchAnnotate",
"id": "vision.images.asyncBatchAnnotate",
"httpMethod": "POST",
"flatPath": "v1/images:asyncBatchAnnotate",
"parameters": {}
},
"annotate": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"httpMethod": "POST",
"parameters": {},
"path": "v1/images:annotate",
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"flatPath": "v1/images:annotate",
"parameterOrder": [],
"id": "vision.images.annotate",
"description": "Run image detection and annotation for a batch of images."
}
}
},
"projects": {
"resources": {
"images": {
"methods": {
"annotate": {
"parameters": {
"parent": {
"location": "path",
"type": "string",
"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`.",
"required": true
}
},
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"path": "v1/{+parent}/images:annotate",
"flatPath": "v1/projects/{projectsId}/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"description": "Run image detection and annotation for a batch of images.",
"id": "vision.projects.images.annotate",
"httpMethod": "POST"
},
"asyncBatchAnnotate": {
"response": {
"$ref": "Operation"
},
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"pattern": "^projects/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"httpMethod": "POST",
"path": "v1/{+parent}/images:asyncBatchAnnotate",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameterOrder": [
"parent"
],
"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": "AsyncBatchAnnotateImagesRequest"
},
"flatPath": "v1/projects/{projectsId}/images:asyncBatchAnnotate"
}
}
},
"operations": {
"methods": {
"get": {
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"parameters": {
"name": {
"location": "path",
"required": true,
"description": "The name of the operation resource.",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"id": "vision.projects.operations.get",
"httpMethod": "GET"
}
}
},
"locations": {
"resources": {
"files": {
"methods": {
"annotate": {
"id": "vision.projects.locations.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.",
"httpMethod": "POST",
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"path": "v1/{+parent}/files:annotate",
"parameterOrder": [
"parent"
],
"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`.",
"required": true,
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/files:annotate"
},
"asyncBatchAnnotate": {
"parameterOrder": [
"parent"
],
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"id": "vision.projects.locations.files.asyncBatchAnnotate",
"description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).",
"parameters": {
"parent": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"path": "v1/{+parent}/files:asyncBatchAnnotate",
"response": {
"$ref": "Operation"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/files:asyncBatchAnnotate",
"httpMethod": "POST"
}
}
},
"products": {
"resources": {
"referenceImages": {
"methods": {
"list": {
"path": "v1/{+parent}/referenceImages",
"description": "Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.",
"response": {
"$ref": "ListReferenceImagesResponse"
},
"id": "vision.projects.locations.products.referenceImages.list",
"parameters": {
"pageToken": {
"description": "A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified.",
"location": "query",
"type": "string"
},
"pageSize": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "The maximum number of items to return. Default 10, maximum 100."
},
"parent": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"description": "Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.",
"type": "string",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages",
"parameterOrder": [
"parent"
]
},
"delete": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$",
"location": "path",
"required": true,
"description": "Required. The resource name of the reference image to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`",
"type": "string"
}
},
"path": "v1/{+name}",
"description": "Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage.",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"id": "vision.projects.locations.products.referenceImages.delete",
"httpMethod": "DELETE",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}"
},
"get": {
"id": "vision.projects.locations.products.referenceImages.get",
"parameterOrder": [
"name"
],
"description": "Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist.",
"path": "v1/{+name}",
"response": {
"$ref": "ReferenceImage"
},
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {
"name": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$"
}
}
},
"create": {
"parameters": {
"referenceImageId": {
"location": "query",
"description": "A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"location": "path",
"required": true,
"type": "string"
}
},
"httpMethod": "POST",
"path": "v1/{+parent}/referenceImages",
"request": {
"$ref": "ReferenceImage"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"description": "Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.",
"response": {
"$ref": "ReferenceImage"
},
"id": "vision.projects.locations.products.referenceImages.create",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages",
"parameterOrder": [
"parent"
]
}
}
}
},
"methods": {
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {
"name": {
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"description": "Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`",
"required": true
}
},
"path": "v1/{+name}",
"id": "vision.projects.locations.products.delete",
"response": {
"$ref": "Empty"
},
"description": "Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}"
},
"list": {
"httpMethod": "GET",
"path": "v1/{+parent}/products",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "ListProductsResponse"
},
"parameters": {
"pageToken": {
"type": "string",
"location": "query",
"description": "The next_page_token returned from a previous List request, if any."
},
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"type": "integer",
"location": "query",
"format": "int32"
},
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID`",
"required": true,
"location": "path",
"type": "string"
}
},
"parameterOrder": [
"parent"
],
"id": "vision.projects.locations.products.list",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products",
"description": "Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1."
},
"create": {
"parameters": {
"productId": {
"description": "A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.",
"type": "string",
"location": "query"
},
"parent": {
"type": "string",
"description": "Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true
}
},
"id": "vision.projects.locations.products.create",
"httpMethod": "POST",
"request": {
"$ref": "Product"
},
"parameterOrder": [
"parent"
],
"description": "Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid.",
"path": "v1/{+parent}/products",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "Product"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products"
},
"purge": {
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"request": {
"$ref": "PurgeProductsRequest"
},
"path": "v1/{+parent}/products:purge",
"httpMethod": "POST",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products:purge",
"id": "vision.projects.locations.products.purge",
"parameters": {
"parent": {
"required": true,
"type": "string",
"description": "Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"description": "Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress)",
"parameterOrder": [
"parent"
]
},
"get": {
"description": "Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist.",
"id": "vision.projects.locations.products.get",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}",
"httpMethod": "GET",
"parameters": {
"name": {
"required": true,
"description": "Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`",
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$"
}
},
"path": "v1/{+name}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameterOrder": [
"name"
],
"response": {
"$ref": "Product"
}
},
"patch": {
"response": {
"$ref": "Product"
},
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"request": {
"$ref": "Product"
},
"description": "Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask.",
"parameters": {
"name": {
"required": true,
"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.",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"location": "path",
"type": "string"
},
"updateMask": {
"description": "The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`.",
"location": "query",
"type": "string",
"format": "google-fieldmask"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"httpMethod": "PATCH",
"id": "vision.projects.locations.products.patch",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}"
}
}
},
"images": {
"methods": {
"annotate": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"description": "Run image detection and annotation for a batch of images.",
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"id": "vision.projects.locations.images.annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"httpMethod": "POST",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/images:annotate",
"path": "v1/{+parent}/images:annotate",
"parameters": {
"parent": {
"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/[^/]+$",
"type": "string"
}
},
"parameterOrder": [
"parent"
]
},
"asyncBatchAnnotate": {
"httpMethod": "POST",
"description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.",
"request": {
"$ref": "AsyncBatchAnnotateImagesRequest"
},
"parameterOrder": [
"parent"
],
"response": {
"$ref": "Operation"
},
"id": "vision.projects.locations.images.asyncBatchAnnotate",
"path": "v1/{+parent}/images:asyncBatchAnnotate",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate"
}
}
},
"productSets": {
"methods": {
"removeProduct": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"description": "Removes a Product from the specified ProductSet.",
"id": "vision.projects.locations.productSets.removeProduct",
"request": {
"$ref": "RemoveProductFromProductSetRequest"
},
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:removeProduct",
"response": {
"$ref": "Empty"
},
"httpMethod": "POST",
"parameters": {
"name": {
"type": "string",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`"
}
},
"path": "v1/{+name}:removeProduct"
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"id": "vision.projects.locations.productSets.list",
"parameters": {
"pageToken": {
"description": "The next_page_token returned from a previous List request, if any.",
"type": "string",
"location": "query"
},
"parent": {
"description": "Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"type": "string",
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"location": "query",
"format": "int32",
"type": "integer"
}
},
"parameterOrder": [
"parent"
],
"description": "Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.",
"httpMethod": "GET",
"response": {
"$ref": "ListProductSetsResponse"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets",
"path": "v1/{+parent}/productSets"
},
"addProduct": {
"parameters": {
"name": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"location": "path",
"description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"required": true
}
},
"description": "Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't exist.",
"id": "vision.projects.locations.productSets.addProduct",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"path": "v1/{+name}:addProduct",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"request": {
"$ref": "AddProductToProductSetRequest"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:addProduct"
},
"delete": {
"path": "v1/{+name}",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"id": "vision.projects.locations.productSets.delete",
"description": "Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}",
"parameters": {
"name": {
"location": "path",
"description": "Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$"
}
},
"response": {
"$ref": "Empty"
}
},
"import": {
"path": "v1/{+parent}/productSets:import",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"description": "Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri.",
"id": "vision.projects.locations.productSets.import",
"response": {
"$ref": "Operation"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"type": "string",
"required": true,
"description": "Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`."
}
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"request": {
"$ref": "ImportProductSetsRequest"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets:import"
},
"get": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"description": "Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameterOrder": [
"name"
],
"response": {
"$ref": "ProductSet"
},
"httpMethod": "GET",
"description": "Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist.",
"path": "v1/{+name}",
"id": "vision.projects.locations.productSets.get"
},
"patch": {
"response": {
"$ref": "ProductSet"
},
"parameterOrder": [
"name"
],
"request": {
"$ref": "ProductSet"
},
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"id": "vision.projects.locations.productSets.patch",
"parameters": {
"name": {
"type": "string",
"required": true,
"description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet.",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"location": "path"
},
"updateMask": {
"description": "The FieldMask that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`.",
"location": "query",
"format": "google-fieldmask",
"type": "string"
}
},
"path": "v1/{+name}",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}",
"description": "Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters."
},
"create": {
"parameterOrder": [
"parent"
],
"description": "Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.",
"path": "v1/{+parent}/productSets",
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"type": "string",
"required": true
},
"productSetId": {
"type": "string",
"description": "A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.",
"location": "query"
}
},
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets",
"id": "vision.projects.locations.productSets.create",
"request": {
"$ref": "ProductSet"
}
}
},
"resources": {
"products": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "ListProductsInProductSetResponse"
},
"parameters": {
"pageSize": {
"format": "int32",
"description": "The maximum number of items to return. Default 10, maximum 100.",
"location": "query",
"type": "integer"
},
"name": {
"location": "path",
"description": "Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
},
"pageToken": {
"location": "query",
"description": "The next_page_token returned from a previous List request, if any.",
"type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}/products",
"id": "vision.projects.locations.productSets.products.list",
"parameterOrder": [
"name"
],
"path": "v1/{+name}/products",
"description": "Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.",
"httpMethod": "GET"
}
}
}
}
},
"operations": {
"methods": {
"get": {
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"id": "vision.projects.locations.operations.get",
"response": {
"$ref": "Operation"
},
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"parameters": {
"name": {
"description": "The name of the operation resource.",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"type": "string",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
}
}
}
}
},
"files": {
"methods": {
"asyncBatchAnnotate": {
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"path": "v1/{+parent}/files:asyncBatchAnnotate",
"parameters": {
"parent": {
"type": "string",
"required": true,
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"id": "vision.projects.files.asyncBatchAnnotate",
"description": "Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results).",
"flatPath": "v1/projects/{projectsId}/files:asyncBatchAnnotate",
"parameterOrder": [
"parent"
]
},
"annotate": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"path": "v1/{+parent}/files:annotate",
"parameterOrder": [
"parent"
],
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"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.",
"parameters": {
"parent": {
"type": "string",
"location": "path",
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"required": true,
"pattern": "^projects/[^/]+$"
}
},
"id": "vision.projects.files.annotate",
"httpMethod": "POST",
"flatPath": "v1/projects/{projectsId}/files:annotate"
}
}
}
}
},
"locations": {
"resources": {
"operations": {
"methods": {
"get": {
"response": {
"$ref": "Operation"
},
"parameters": {
"name": {
"description": "The name of the operation resource.",
"required": true,
"pattern": "^locations/[^/]+/operations/[^/]+$",
"type": "string",
"location": "path"
}
},
"flatPath": "v1/locations/{locationsId}/operations/{operationsId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"path": "v1/{+name}",
"httpMethod": "GET",
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"id": "vision.locations.operations.get",
"parameterOrder": [
"name"
]
}
}
}
}
},
"operations": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "Empty"
},
"id": "vision.operations.delete",
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"required": true,
"pattern": "^operations/.*$",
"type": "string",
"description": "The name of the operation resource to be deleted."
}
}
},
"cancel": {
"id": "vision.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"parameterOrder": [
"name"
],
"request": {
"$ref": "CancelOperationRequest"
},
"flatPath": "v1/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
"location": "path",
"pattern": "^operations/.*$"
}
},
"response": {
"$ref": "Empty"
},
"httpMethod": "POST"
},
"list": {
"flatPath": "v1/operations",
"id": "vision.operations.list",
"parameters": {
"filter": {
"type": "string",
"location": "query",
"description": "The standard list filter."
},
"name": {
"required": true,
"description": "The name of the operation's parent resource.",
"pattern": "^operations$",
"location": "path",
"type": "string"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The standard list page token."
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
"response": {
"$ref": "ListOperationsResponse"
},
"path": "v1/{+name}"
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
"path": "v1/{+name}",
"flatPath": "v1/operations/{operationsId}",
"parameters": {
"name": {
"location": "path",
"required": true,
"type": "string",
"description": "The name of the operation resource.",
"pattern": "^operations/[^/]+$"
}
},
"parameterOrder": [
"name"
],
"id": "vision.operations.get",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
}
},
"title": "Cloud Vision API",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-vision": {
"description": "Apply machine learning models to understand and label images"
}
}
}
},
"fullyEncodeReservedExpansion": true,
"protocol": "rest"
}