blob: 91bd705825ded531f24272a4eee44ac7bc97cdda [file] [log] [blame]
{
"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"
}
}
}
},
"basePath": "",
"baseUrl": "https://vision.googleapis.com/",
"batchPath": "batch",
"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.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/vision/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "vision:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://vision.mtls.googleapis.com/",
"name": "vision",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"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"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"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"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"files": {
"methods": {
"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.",
"flatPath": "v1/files:annotate",
"httpMethod": "POST",
"id": "vision.files.annotate",
"parameterOrder": [],
"parameters": {},
"path": "v1/files:annotate",
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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/files:asyncBatchAnnotate",
"httpMethod": "POST",
"id": "vision.files.asyncBatchAnnotate",
"parameterOrder": [],
"parameters": {},
"path": "v1/files:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"images": {
"methods": {
"annotate": {
"description": "Run image detection and annotation for a batch of images.",
"flatPath": "v1/images:annotate",
"httpMethod": "POST",
"id": "vision.images.annotate",
"parameterOrder": [],
"parameters": {},
"path": "v1/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"asyncBatchAnnotate": {
"description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.",
"flatPath": "v1/images:asyncBatchAnnotate",
"httpMethod": "POST",
"id": "vision.images.asyncBatchAnnotate",
"parameterOrder": [],
"parameters": {},
"path": "v1/images:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateImagesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"locations": {
"resources": {
"operations": {
"methods": {
"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.",
"flatPath": "v1/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "vision.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
}
}
},
"operations": {
"methods": {
"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`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "vision.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "vision.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "vision.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"list": {
"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.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "vision.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"projects": {
"resources": {
"files": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/files:annotate",
"httpMethod": "POST",
"id": "vision.projects.files.annotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/files:annotate",
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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",
"httpMethod": "POST",
"id": "vision.projects.files.asyncBatchAnnotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/files:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"images": {
"methods": {
"annotate": {
"description": "Run image detection and annotation for a batch of images.",
"flatPath": "v1/projects/{projectsId}/images:annotate",
"httpMethod": "POST",
"id": "vision.projects.images.annotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"asyncBatchAnnotate": {
"description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.",
"flatPath": "v1/projects/{projectsId}/images:asyncBatchAnnotate",
"httpMethod": "POST",
"id": "vision.projects.images.asyncBatchAnnotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/images:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateImagesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"locations": {
"resources": {
"files": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/files:annotate",
"httpMethod": "POST",
"id": "vision.projects.locations.files.annotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/files:annotate",
"request": {
"$ref": "BatchAnnotateFilesRequest"
},
"response": {
"$ref": "BatchAnnotateFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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}/locations/{locationsId}/files:asyncBatchAnnotate",
"httpMethod": "POST",
"id": "vision.projects.locations.files.asyncBatchAnnotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/files:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateFilesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"images": {
"methods": {
"annotate": {
"description": "Run image detection and annotation for a batch of images.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/images:annotate",
"httpMethod": "POST",
"id": "vision.projects.locations.images.annotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"asyncBatchAnnotate": {
"description": "Run asynchronous image detection and annotation for a list of images. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/images:asyncBatchAnnotate",
"httpMethod": "POST",
"id": "vision.projects.locations.images.asyncBatchAnnotate",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/images:asyncBatchAnnotate",
"request": {
"$ref": "AsyncBatchAnnotateImagesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"operations": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "vision.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
},
"productSets": {
"methods": {
"addProduct": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:addProduct",
"httpMethod": "POST",
"id": "vision.projects.locations.productSets.addProduct",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:addProduct",
"request": {
"$ref": "AddProductToProductSetRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"create": {
"description": "Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets",
"httpMethod": "POST",
"id": "vision.projects.locations.productSets.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"productSetId": {
"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",
"type": "string"
}
},
"path": "v1/{+parent}/productSets",
"request": {
"$ref": "ProductSet"
},
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"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}",
"httpMethod": "DELETE",
"id": "vision.projects.locations.productSets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"get": {
"description": "Gets information associated with a ProductSet. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}",
"httpMethod": "GET",
"id": "vision.projects.locations.productSets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the ProductSet to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"import": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets:import",
"httpMethod": "POST",
"id": "vision.projects.locations.productSets.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/productSets:import",
"request": {
"$ref": "ImportProductSetsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"list": {
"description": "Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets",
"httpMethod": "GET",
"id": "vision.projects.locations.productSets.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/productSets",
"response": {
"$ref": "ListProductSetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"patch": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}",
"httpMethod": "PATCH",
"id": "vision.projects.locations.productSets.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"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 path is `display_name`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "ProductSet"
},
"response": {
"$ref": "ProductSet"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"removeProduct": {
"description": "Removes a Product from the specified ProductSet.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}:removeProduct",
"httpMethod": "POST",
"id": "vision.projects.locations.productSets.removeProduct",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:removeProduct",
"request": {
"$ref": "RemoveProductFromProductSetRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
},
"resources": {
"products": {
"methods": {
"list": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/productSets/{productSetsId}/products",
"httpMethod": "GET",
"id": "vision.projects.locations.productSets.products.list",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/productSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token returned from a previous List request, if any.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/products",
"response": {
"$ref": "ListProductsInProductSetResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
}
}
},
"products": {
"methods": {
"create": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products",
"httpMethod": "POST",
"id": "vision.projects.locations.products.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"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,
"type": "string"
},
"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 `/`.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/products",
"request": {
"$ref": "Product"
},
"response": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"delete": {
"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}",
"httpMethod": "DELETE",
"id": "vision.projects.locations.products.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"get": {
"description": "Gets information associated with a Product. Possible errors: * Returns NOT_FOUND if the Product does not exist.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}",
"httpMethod": "GET",
"id": "vision.projects.locations.products.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"list": {
"description": "Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products",
"httpMethod": "GET",
"id": "vision.projects.locations.products.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/products",
"response": {
"$ref": "ListProductsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"patch": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}",
"httpMethod": "PATCH",
"id": "vision.projects.locations.products.patch",
"parameterOrder": [
"name"
],
"parameters": {
"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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"required": true,
"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`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Product"
},
"response": {
"$ref": "Product"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"purge": {
"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)",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products:purge",
"httpMethod": "POST",
"id": "vision.projects.locations.products.purge",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"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/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/products:purge",
"request": {
"$ref": "PurgeProductsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
},
"resources": {
"referenceImages": {
"methods": {
"create": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages",
"httpMethod": "POST",
"id": "vision.projects.locations.products.referenceImages.create",
"parameterOrder": [
"parent"
],
"parameters": {
"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`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"required": true,
"type": "string"
},
"referenceImageId": {
"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 `/`.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/referenceImages",
"request": {
"$ref": "ReferenceImage"
},
"response": {
"$ref": "ReferenceImage"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"delete": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}",
"httpMethod": "DELETE",
"id": "vision.projects.locations.products.referenceImages.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"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`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"get": {
"description": "Gets information associated with a ReferenceImage. Possible errors: * Returns NOT_FOUND if the specified image does not exist.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages/{referenceImagesId}",
"httpMethod": "GET",
"id": "vision.projects.locations.products.referenceImages.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the ReferenceImage to get. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/referenceImages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ReferenceImage"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
},
"list": {
"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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/referenceImages",
"httpMethod": "GET",
"id": "vision.projects.locations.products.referenceImages.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. Default 10, maximum 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"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"
},
"parent": {
"description": "Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/referenceImages",
"response": {
"$ref": "ListReferenceImagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
}
}
}
}
},
"operations": {
"methods": {
"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.",
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "vision.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
]
}
}
}
}
}
},
"revision": "20200828",
"rootUrl": "https://vision.googleapis.com/",
"schemas": {
"AddProductToProductSetRequest": {
"description": "Request message for the `AddProductToProductSet` method.",
"id": "AddProductToProductSetRequest",
"properties": {
"product": {
"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`",
"type": "string"
}
},
"type": "object"
},
"AnnotateFileRequest": {
"description": "A request to annotate one single file, e.g. a PDF, TIFF or GIF file.",
"id": "AnnotateFileRequest",
"properties": {
"features": {
"description": "Required. Requested features.",
"items": {
"$ref": "Feature"
},
"type": "array"
},
"imageContext": {
"$ref": "ImageContext",
"description": "Additional context that may accompany the image(s) in the file."
},
"inputConfig": {
"$ref": "InputConfig",
"description": "Required. Information about the input 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.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"AnnotateFileResponse": {
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.",
"id": "AnnotateFileResponse",
"properties": {
"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": "InputConfig",
"description": "Information about the file for which this response is generated."
},
"responses": {
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "AnnotateImageResponse"
},
"type": "array"
},
"totalPages": {
"description": "This field gives the total number of pages in the file.",
"format": "int32",
"type": "integer"
}
},
"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.",
"id": "AnnotateImageRequest",
"properties": {
"features": {
"description": "Requested features.",
"items": {
"$ref": "Feature"
},
"type": "array"
},
"image": {
"$ref": "Image",
"description": "The image to be processed."
},
"imageContext": {
"$ref": "ImageContext",
"description": "Additional context that may accompany the image."
}
},
"type": "object"
},
"AnnotateImageResponse": {
"description": "Response to an image annotation request.",
"id": "AnnotateImageResponse",
"properties": {
"context": {
"$ref": "ImageAnnotationContext",
"description": "If present, contextual information is needed to understand where this image comes from."
},
"cropHintsAnnotation": {
"$ref": "CropHintsAnnotation",
"description": "If present, crop hints have completed 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."
},
"faceAnnotations": {
"description": "If present, face detection has completed successfully.",
"items": {
"$ref": "FaceAnnotation"
},
"type": "array"
},
"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."
},
"imagePropertiesAnnotation": {
"$ref": "ImageProperties",
"description": "If present, image properties were extracted successfully."
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
"items": {
"$ref": "EntityAnnotation"
},
"type": "array"
},
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "EntityAnnotation"
},
"type": "array"
},
"localizedObjectAnnotations": {
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"items": {
"$ref": "LocalizedObjectAnnotation"
},
"type": "array"
},
"logoAnnotations": {
"description": "If present, logo detection has completed successfully.",
"items": {
"$ref": "EntityAnnotation"
},
"type": "array"
},
"productSearchResults": {
"$ref": "ProductSearchResults",
"description": "If present, product search has completed successfully."
},
"safeSearchAnnotation": {
"$ref": "SafeSearchAnnotation",
"description": "If present, safe-search annotation has completed successfully."
},
"textAnnotations": {
"description": "If present, text (OCR) detection has completed successfully.",
"items": {
"$ref": "EntityAnnotation"
},
"type": "array"
},
"webDetection": {
"$ref": "WebDetection",
"description": "If present, web detection has completed successfully."
}
},
"type": "object"
},
"AsyncAnnotateFileRequest": {
"description": "An offline file annotation request.",
"id": "AsyncAnnotateFileRequest",
"properties": {
"features": {
"description": "Required. Requested features.",
"items": {
"$ref": "Feature"
},
"type": "array"
},
"imageContext": {
"$ref": "ImageContext",
"description": "Additional context that may accompany the image(s) in the file."
},
"inputConfig": {
"$ref": "InputConfig",
"description": "Required. Information about the input file."
},
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. The desired output location and metadata (e.g. format)."
}
},
"type": "object"
},
"AsyncAnnotateFileResponse": {
"description": "The response for a single offline file annotation request.",
"id": "AsyncAnnotateFileResponse",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "The output location and metadata from AsyncAnnotateFileRequest."
}
},
"type": "object"
},
"AsyncBatchAnnotateFilesRequest": {
"description": "Multiple async file annotation requests are batched into a single service call.",
"id": "AsyncBatchAnnotateFilesRequest",
"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": {
"description": "Required. Individual async file annotation requests for this batch.",
"items": {
"$ref": "AsyncAnnotateFileRequest"
},
"type": "array"
}
},
"type": "object"
},
"AsyncBatchAnnotateFilesResponse": {
"description": "Response to an async batch file annotation request.",
"id": "AsyncBatchAnnotateFilesResponse",
"properties": {
"responses": {
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"items": {
"$ref": "AsyncAnnotateFileResponse"
},
"type": "array"
}
},
"type": "object"
},
"AsyncBatchAnnotateImagesRequest": {
"description": "Request for async image annotation for a list of images.",
"id": "AsyncBatchAnnotateImagesRequest",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "Required. The desired output location and metadata (e.g. format)."
},
"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": {
"description": "Required. Individual image annotation requests for this batch.",
"items": {
"$ref": "AnnotateImageRequest"
},
"type": "array"
}
},
"type": "object"
},
"AsyncBatchAnnotateImagesResponse": {
"description": "Response to an async batch image annotation request.",
"id": "AsyncBatchAnnotateImagesResponse",
"properties": {
"outputConfig": {
"$ref": "OutputConfig",
"description": "The output location and metadata from AsyncBatchAnnotateImagesRequest."
}
},
"type": "object"
},
"BatchAnnotateFilesRequest": {
"description": "A list of requests to annotate files using the BatchAnnotateFiles API.",
"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": {
"description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.",
"items": {
"$ref": "AnnotateFileRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchAnnotateFilesResponse": {
"description": "A list of file annotation responses.",
"id": "BatchAnnotateFilesResponse",
"properties": {
"responses": {
"description": "The list of file annotation responses, each response corresponding to each AnnotateFileRequest in BatchAnnotateFilesRequest.",
"items": {
"$ref": "AnnotateFileResponse"
},
"type": "array"
}
},
"type": "object"
},
"BatchAnnotateImagesRequest": {
"description": "Multiple image annotation requests are batched into a single service call.",
"id": "BatchAnnotateImagesRequest",
"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": {
"description": "Required. Individual image annotation requests for this batch.",
"items": {
"$ref": "AnnotateImageRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchAnnotateImagesResponse": {
"description": "Response to a batch image annotation request.",
"id": "BatchAnnotateImagesResponse",
"properties": {
"responses": {
"description": "Individual responses to image annotation requests within the batch.",
"items": {
"$ref": "AnnotateImageResponse"
},
"type": "array"
}
},
"type": "object"
},
"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.",
"id": "BatchOperationMetadata",
"properties": {
"endTime": {
"description": "The time when the batch request is finished and google.longrunning.Operation.done is set to true.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The current state of the batch operation.",
"enum": [
"STATE_UNSPECIFIED",
"PROCESSING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Invalid.",
"Request is actively being processed.",
"The request is done and at least one item has been successfully processed.",
"The request is done and no item has been successfully processed.",
"The request is done after the longrunning.Operations.CancelOperation has been called by the user. Any records that were processed before the cancel command are output as specified in the request."
],
"type": "string"
},
"submitTime": {
"description": "The time when the batch request was submitted to the server.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Block": {
"description": "Logical element on the page.",
"id": "Block",
"properties": {
"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"
},
"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)."
},
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"format": "float",
"type": "number"
},
"paragraphs": {
"description": "List of paragraphs in this block (if this blocks is of type text).",
"items": {
"$ref": "Paragraph"
},
"type": "array"
},
"property": {
"$ref": "TextProperty",
"description": "Additional information detected for the block."
}
},
"type": "object"
},
"BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "BoundingPoly",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "Vertex"
},
"type": "array"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"Color": {
"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:\u0026red green:\u0026green blue:\u0026blue alpha:\u0026alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...",
"id": "Color",
"properties": {
"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"
},
"blue": {
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
},
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"id": "ColorInfo",
"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].",
"format": "float",
"type": "number"
},
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CropHint": {
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"id": "CropHint",
"properties": {
"boundingPoly": {
"$ref": "BoundingPoly",
"description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale."
},
"confidence": {
"description": "Confidence of this being a salient region. Range [0, 1].",
"format": "float",
"type": "number"
},
"importanceFraction": {
"description": "Fraction of importance of this salient region with respect to the original image.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
"id": "CropHintsAnnotation",
"properties": {
"cropHints": {
"description": "Crop hint results.",
"items": {
"$ref": "CropHint"
},
"type": "array"
}
},
"type": "object"
},
"CropHintsParams": {
"description": "Parameters for crop hints annotation request.",
"id": "CropHintsParams",
"properties": {
"aspectRatios": {
"description": "Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.",
"items": {
"format": "float",
"type": "number"
},
"type": "array"
}
},
"type": "object"
},
"DetectedBreak": {
"description": "Detected start or end of a structural component.",
"id": "DetectedBreak",
"properties": {
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
},
"type": {
"description": "Detected break type.",
"enum": [
"UNKNOWN",
"SPACE",
"SURE_SPACE",
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
],
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
"Sure space (very wide).",
"Line-wrapping break.",
"End-line hyphen that is not present in text; does not co-occur with `SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
"Line break that ends a paragraph."
],
"type": "string"
}
},
"type": "object"
},
"DetectedLanguage": {
"description": "Detected language for a structural component.",
"id": "DetectedLanguage",
"properties": {
"confidence": {
"description": "Confidence of detected language. Range [0, 1].",
"format": "float",
"type": "number"
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
}
},
"type": "object"
},
"DominantColorsAnnotation": {
"description": "Set of dominant colors and their corresponding scores.",
"id": "DominantColorsAnnotation",
"properties": {
"colors": {
"description": "RGB color values with their score and pixel fraction.",
"items": {
"$ref": "ColorInfo"
},
"type": "array"
}
},
"type": "object"
},
"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 `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"EntityAnnotation": {
"description": "Set of detected entity features.",
"id": "EntityAnnotation",
"properties": {
"boundingPoly": {
"$ref": "BoundingPoly",
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features."
},
"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"
},
"description": {
"description": "Entity textual description, expressed in its `locale` language.",
"type": "string"
},
"locale": {
"description": "The language code for the locale in which the entity textual `description` is expressed.",
"type": "string"
},
"locations": {
"description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.",
"items": {
"$ref": "LocationInfo"
},
"type": "array"
},
"mid": {
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
"type": "string"
},
"properties": {
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.",
"items": {
"$ref": "Property"
},
"type": "array"
},
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
"type": "number"
},
"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"
}
},
"type": "object"
},
"FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"id": "FaceAnnotation",
"properties": {
"angerLikelihood": {
"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."
],
"type": "string"
},
"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"
},
"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."
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"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."
},
"headwearLikelihood": {
"description": "Headwear 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"
},
"joyLikelihood": {
"description": "Joy likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"landmarkingConfidence": {
"description": "Face landmarking confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"landmarks": {
"description": "Detected face landmarks.",
"items": {
"$ref": "Landmark"
},
"type": "array"
},
"panAngle": {
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].",
"format": "float",
"type": "number"
},
"rollAngle": {
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].",
"format": "float",
"type": "number"
},
"sorrowLikelihood": {
"description": "Sorrow 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"
},
"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"
},
"tiltAngle": {
"description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].",
"format": "float",
"type": "number"
},
"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"
}
},
"type": "object"
},
"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": {
"maxResults": {
"description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.",
"format": "int32",
"type": "integer"
},
"model": {
"description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\".",
"type": "string"
},
"type": {
"description": "The feature type.",
"enum": [
"TYPE_UNSPECIFIED",
"FACE_DETECTION",
"LANDMARK_DETECTION",
"LOGO_DETECTION",
"LABEL_DETECTION",
"TEXT_DETECTION",
"DOCUMENT_TEXT_DETECTION",
"SAFE_SEARCH_DETECTION",
"IMAGE_PROPERTIES",
"CROP_HINTS",
"WEB_DETECTION",
"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."
],
"type": "string"
}
},
"type": "object"
},
"GcsDestination": {
"description": "The Google Cloud Storage location where the output will be written to.",
"id": "GcsDestination",
"properties": {
"uri": {
"description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.",
"type": "string"
}
},
"type": "object"
},
"GcsSource": {
"description": "The Google Cloud Storage location where the input will be read from.",
"id": "GcsSource",
"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"
},
"GoogleCloudVisionV1p1beta1AnnotateFileResponse": {
"description": "Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.",
"id": "GoogleCloudVisionV1p1beta1AnnotateFileResponse",
"properties": {
"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": "GoogleCloudVisionV1p1beta1InputConfig",
"description": "Information about the file for which this response is generated."
},
"responses": {
"description": "Individual responses to images found within the file. This field will be empty if the `error` field is set.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse"
},
"type": "array"
},
"totalPages": {
"description": "This field gives the total number of pages in the file.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1AnnotateImageResponse": {
"description": "Response to an image annotation request.",
"id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse",
"properties": {
"context": {
"$ref": "GoogleCloudVisionV1p1beta1ImageAnnotationContext",
"description": "If present, contextual information is needed to understand where this image comes from."
},
"cropHintsAnnotation": {
"$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation",
"description": "If present, crop hints have completed 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."
},
"faceAnnotations": {
"description": "If present, face detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation"
},
"type": "array"
},
"fullTextAnnotation": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotation",
"description": "If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text."
},
"imagePropertiesAnnotation": {
"$ref": "GoogleCloudVisionV1p1beta1ImageProperties",
"description": "If present, image properties were extracted successfully."
},
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"localizedObjectAnnotations": {
"description": "If present, localized object detection has completed successfully. This will be sorted descending by confidence score.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation"
},
"type": "array"
},
"logoAnnotations": {
"description": "If present, logo detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"productSearchResults": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResults",
"description": "If present, product search has completed successfully."
},
"safeSearchAnnotation": {
"$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation",
"description": "If present, safe-search annotation has completed successfully."
},
"textAnnotations": {
"description": "If present, text (OCR) detection has completed successfully.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"type": "array"
},
"webDetection": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetection",
"description": "If present, web detection has completed successfully."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse": {
"description": "The response for a single offline file annotation request.",
"id": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse",
"properties": {
"outputConfig": {
"$ref": "GoogleCloudVisionV1p1beta1OutputConfig",
"description": "The output location and metadata from AsyncAnnotateFileRequest."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse": {
"description": "Response to an async batch file annotation request.",
"id": "GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesResponse",
"properties": {
"responses": {
"description": "The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1AsyncAnnotateFileResponse"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Block": {
"description": "Logical element on the page.",
"id": "GoogleCloudVisionV1p1beta1Block",
"properties": {
"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"
},
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding box for the block. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"confidence": {
"description": "Confidence of the OCR results on the block. Range [0, 1].",
"format": "float",
"type": "number"
},
"paragraphs": {
"description": "List of paragraphs in this block (if this blocks is of type text).",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Paragraph"
},
"type": "array"
},
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected for the block."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
"id": "GoogleCloudVisionV1p1beta1BoundingPoly",
"properties": {
"normalizedVertices": {
"description": "The bounding polygon normalized vertices.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1NormalizedVertex"
},
"type": "array"
},
"vertices": {
"description": "The bounding polygon vertices.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Vertex"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ColorInfo": {
"description": "Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.",
"id": "GoogleCloudVisionV1p1beta1ColorInfo",
"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].",
"format": "float",
"type": "number"
},
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1CropHint": {
"description": "Single crop hint that is used to generate a new crop when serving an image.",
"id": "GoogleCloudVisionV1p1beta1CropHint",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding polygon for the crop region. The coordinates of the bounding box are in the original image's scale."
},
"confidence": {
"description": "Confidence of this being a salient region. Range [0, 1].",
"format": "float",
"type": "number"
},
"importanceFraction": {
"description": "Fraction of importance of this salient region with respect to the original image.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
"id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation",
"properties": {
"cropHints": {
"description": "Crop hint results.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1CropHint"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1DominantColorsAnnotation": {
"description": "Set of dominant colors and their corresponding scores.",
"id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
"properties": {
"colors": {
"description": "RGB color values with their score and pixel fraction.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ColorInfo"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1EntityAnnotation": {
"description": "Set of detected entity features.",
"id": "GoogleCloudVisionV1p1beta1EntityAnnotation",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "Image region to which this entity belongs. Not produced for `LABEL_DETECTION` features."
},
"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"
},
"description": {
"description": "Entity textual description, expressed in its `locale` language.",
"type": "string"
},
"locale": {
"description": "The language code for the locale in which the entity textual `description` is expressed.",
"type": "string"
},
"locations": {
"description": "The location information for the detected entity. Multiple `LocationInfo` elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. Location information is usually present for landmarks.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1LocationInfo"
},
"type": "array"
},
"mid": {
"description": "Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
"type": "string"
},
"properties": {
"description": "Some entities may have optional user-supplied `Property` (name/value) fields, such a score or string that qualifies the entity.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Property"
},
"type": "array"
},
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
"type": "number"
},
"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"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"id": "GoogleCloudVisionV1p1beta1FaceAnnotation",
"properties": {
"angerLikelihood": {
"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."
],
"type": "string"
},
"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"
},
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding polygon around the face. The coordinates of the bounding box are in the original image's scale. The bounding box is computed to \"frame\" the face in accordance with human expectations. It is based on the landmarker results. Note that one or more x and/or y coordinates may not be generated in the `BoundingPoly` (the polygon will be unbounded) if only a partial face appears in the image to be annotated."
},
"detectionConfidence": {
"description": "Detection confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"fdBoundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The `fd_bounding_poly` bounding polygon is tighter than the `boundingPoly`, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the \"amount of skin\" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence the fd (face detection) prefix."
},
"headwearLikelihood": {
"description": "Headwear 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"
},
"joyLikelihood": {
"description": "Joy likelihood.",
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
"UNLIKELY",
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
],
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely.",
"It is unlikely.",
"It is possible.",
"It is likely.",
"It is very likely."
],
"type": "string"
},
"landmarkingConfidence": {
"description": "Face landmarking confidence. Range [0, 1].",
"format": "float",
"type": "number"
},
"landmarks": {
"description": "Detected face landmarks.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
},
"type": "array"
},
"panAngle": {
"description": "Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].",
"format": "float",
"type": "number"
},
"rollAngle": {
"description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].",
"format": "float",
"type": "number"
},
"sorrowLikelihood": {
"description": "Sorrow 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"
},
"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"
},
"tiltAngle": {
"description": "Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].",
"format": "float",
"type": "number"
},
"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"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": {
"description": "A face-specific landmark (for example, a face feature).",
"id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark",
"properties": {
"position": {
"$ref": "GoogleCloudVisionV1p1beta1Position",
"description": "Face landmark position."
},
"type": {
"description": "Face landmark type.",
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
"RIGHT_EYE",
"LEFT_OF_LEFT_EYEBROW",
"RIGHT_OF_LEFT_EYEBROW",
"LEFT_OF_RIGHT_EYEBROW",
"RIGHT_OF_RIGHT_EYEBROW",
"MIDPOINT_BETWEEN_EYES",
"NOSE_TIP",
"UPPER_LIP",
"LOWER_LIP",
"MOUTH_LEFT",
"MOUTH_RIGHT",
"MOUTH_CENTER",
"NOSE_BOTTOM_RIGHT",
"NOSE_BOTTOM_LEFT",
"NOSE_BOTTOM_CENTER",
"LEFT_EYE_TOP_BOUNDARY",
"LEFT_EYE_RIGHT_CORNER",
"LEFT_EYE_BOTTOM_BOUNDARY",
"LEFT_EYE_LEFT_CORNER",
"RIGHT_EYE_TOP_BOUNDARY",
"RIGHT_EYE_RIGHT_CORNER",
"RIGHT_EYE_BOTTOM_BOUNDARY",
"RIGHT_EYE_LEFT_CORNER",
"LEFT_EYEBROW_UPPER_MIDPOINT",
"RIGHT_EYEBROW_UPPER_MIDPOINT",
"LEFT_EAR_TRAGION",
"RIGHT_EAR_TRAGION",
"LEFT_EYE_PUPIL",
"RIGHT_EYE_PUPIL",
"FOREHEAD_GLABELLA",
"CHIN_GNATHION",
"CHIN_LEFT_GONION",
"CHIN_RIGHT_GONION",
"LEFT_CHEEK_CENTER",
"RIGHT_CHEEK_CENTER"
],
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
"Left eye.",
"Right eye.",
"Left of left eyebrow.",
"Right of left eyebrow.",
"Left of right eyebrow.",
"Right of right eyebrow.",
"Midpoint between eyes.",
"Nose tip.",
"Upper lip.",
"Lower lip.",
"Mouth left.",
"Mouth right.",
"Mouth center.",
"Nose, bottom right.",
"Nose, bottom left.",
"Nose, bottom center.",
"Left eye, top boundary.",
"Left eye, right corner.",
"Left eye, bottom boundary.",
"Left eye, left corner.",
"Right eye, top boundary.",
"Right eye, right corner.",
"Right eye, bottom boundary.",
"Right eye, left corner.",
"Left eyebrow, upper midpoint.",
"Right eyebrow, upper midpoint.",
"Left ear tragion.",
"Right ear tragion.",
"Left eye pupil.",
"Right eye pupil.",
"Forehead glabella.",
"Chin gnathion.",
"Chin left gonion.",
"Chin right gonion.",
"Left cheek center.",
"Right cheek center."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1GcsDestination": {
"description": "The Google Cloud Storage location where the output will be written to.",
"id": "GoogleCloudVisionV1p1beta1GcsDestination",
"properties": {
"uri": {
"description": "Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide. Examples: * File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with \"filenameprefix\". * Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified. If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1GcsSource": {
"description": "The Google Cloud Storage location where the input will be read from.",
"id": "GoogleCloudVisionV1p1beta1GcsSource",
"properties": {
"uri": {
"description": "Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ImageAnnotationContext": {
"description": "If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.",
"id": "GoogleCloudVisionV1p1beta1ImageAnnotationContext",
"properties": {
"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"
},
"uri": {
"description": "The URI of the file used to produce the image.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ImageProperties": {
"description": "Stores image properties, such as dominant colors.",
"id": "GoogleCloudVisionV1p1beta1ImageProperties",
"properties": {
"dominantColors": {
"$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
"description": "If present, dominant colors completed successfully."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1InputConfig": {
"description": "The desired input location and metadata.",
"id": "GoogleCloudVisionV1p1beta1InputConfig",
"properties": {
"content": {
"description": "File content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. Currently, this field only works for BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles requests.",
"format": "byte",
"type": "string"
},
"gcsSource": {
"$ref": "GoogleCloudVisionV1p1beta1GcsSource",
"description": "The Google Cloud Storage location to read the input from."
},
"mimeType": {
"description": "The type of the file. Currently only \"application/pdf\", \"image/tiff\" and \"image/gif\" are supported. Wildcards are not supported.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation": {
"description": "Set of detected objects with bounding boxes.",
"id": "GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "Image region to which this object belongs. This must be populated."
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"score": {
"description": "Score of the result. Range [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1LocationInfo": {
"description": "Detected entity location information.",
"id": "GoogleCloudVisionV1p1beta1LocationInfo",
"properties": {
"latLng": {
"$ref": "LatLng",
"description": "lat/long location coordinates."
}
},
"type": "object"
},
"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.",
"id": "GoogleCloudVisionV1p1beta1NormalizedVertex",
"properties": {
"x": {
"description": "X coordinate.",
"format": "float",
"type": "number"
},
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1OperationMetadata": {
"description": "Contains metadata for the BatchAnnotateImages operation.",
"id": "GoogleCloudVisionV1p1beta1OperationMetadata",
"properties": {
"createTime": {
"description": "The time when the batch request was received.",
"format": "google-datetime",
"type": "string"
},
"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"
},
"updateTime": {
"description": "The time when the operation result was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1OutputConfig": {
"description": "The desired output location and metadata.",
"id": "GoogleCloudVisionV1p1beta1OutputConfig",
"properties": {
"batchSize": {
"description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.",
"format": "int32",
"type": "integer"
},
"gcsDestination": {
"$ref": "GoogleCloudVisionV1p1beta1GcsDestination",
"description": "The Google Cloud Storage location to write the output(s) to."
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Page": {
"description": "Detected page from OCR.",
"id": "GoogleCloudVisionV1p1beta1Page",
"properties": {
"blocks": {
"description": "List of blocks of text, images etc on this page.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Block"
},
"type": "array"
},
"confidence": {
"description": "Confidence of the OCR results on the page. Range [0, 1].",
"format": "float",
"type": "number"
},
"height": {
"description": "Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"format": "int32",
"type": "integer"
},
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected on the page."
},
"width": {
"description": "Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Paragraph": {
"description": "Structural unit of text representing a number of words in certain order.",
"id": "GoogleCloudVisionV1p1beta1Paragraph",
"properties": {
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding box for the paragraph. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example: * when the text is horizontal it might look like: 0----1 | | 3----2 * when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3)."
},
"confidence": {
"description": "Confidence of the OCR results for the paragraph. Range [0, 1].",
"format": "float",
"type": "number"
},
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected for the paragraph."
},
"words": {
"description": "List of all words in this paragraph.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Word"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Position": {
"description": "A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.",
"id": "GoogleCloudVisionV1p1beta1Position",
"properties": {
"x": {
"description": "X coordinate.",
"format": "float",
"type": "number"
},
"y": {
"description": "Y coordinate.",
"format": "float",
"type": "number"
},
"z": {
"description": "Z coordinate (or depth).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Product": {
"description": "A Product contains ReferenceImages.",
"id": "GoogleCloudVisionV1p1beta1Product",
"properties": {
"description": {
"description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long.",
"type": "string"
},
"displayName": {
"description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.",
"type": "string"
},
"name": {
"description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product.",
"type": "string"
},
"productCategory": {
"description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products.",
"type": "string"
},
"productLabels": {
"description": "Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. \"1199\". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductKeyValue"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductKeyValue": {
"description": "A product label represented as a key-value pair.",
"id": "GoogleCloudVisionV1p1beta1ProductKeyValue",
"properties": {
"key": {
"description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.",
"type": "string"
},
"value": {
"description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResults": {
"description": "Results for a product search request.",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResults",
"properties": {
"indexTime": {
"description": "Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.",
"format": "google-datetime",
"type": "string"
},
"productGroupedResults": {
"description": "List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult"
},
"type": "array"
},
"results": {
"description": "List of results, one for each product match.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": {
"description": "Information about the products similar to a single product in a query image.",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult",
"properties": {
"boundingPoly": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding polygon around the product detected in the query image."
},
"objectAnnotations": {
"description": "List of generic predictions for the object in the bounding box.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation"
},
"type": "array"
},
"results": {
"description": "List of results, one for each product match.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation": {
"description": "Prediction for what the object in the bounding box is.",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation",
"properties": {
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
"type": "string"
},
"mid": {
"description": "Object ID that should align with EntityAnnotation mid.",
"type": "string"
},
"name": {
"description": "Object name, expressed in its `language_code` language.",
"type": "string"
},
"score": {
"description": "Score of the result. Range [0, 1].",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1ProductSearchResultsResult": {
"description": "Information about a product.",
"id": "GoogleCloudVisionV1p1beta1ProductSearchResultsResult",
"properties": {
"image": {
"description": "The resource name of the image from the product that is the closest match to the query.",
"type": "string"
},
"product": {
"$ref": "GoogleCloudVisionV1p1beta1Product",
"description": "The Product."
},
"score": {
"description": "A confidence level on the match, ranging from 0 (no confidence) to 1 (full confidence).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"id": "GoogleCloudVisionV1p1beta1Property",
"properties": {
"name": {
"description": "Name of the property.",
"type": "string"
},
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
"type": "string"
},
"value": {
"description": "Value of the property.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
"description": "Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).",
"id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation",
"properties": {
"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.",
"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"
},
"racy": {
"description": "Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.",
"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"
},
"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"
},
"violence": {
"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."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1Symbol": {
"description": "A single symbol representation.",
"id": "GoogleCloudVisionV1p1beta1Symbol",
"properties": {
"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)."
},
"confidence": {
"description": "Confidence of the OCR results for the symbol. Range [0, 1].",
"format": "float",
"type": "number"
},
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected for the symbol."
},
"text": {
"description": "The actual UTF-8 representation of the symbol.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotation": {
"description": "TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.",
"id": "GoogleCloudVisionV1p1beta1TextAnnotation",
"properties": {
"pages": {
"description": "List of pages detected by OCR.",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Page"
},
"type": "array"
},
"text": {
"description": "UTF-8 text detected on the pages.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": {
"description": "Detected start or end of a structural component.",
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak",
"properties": {
"isPrefix": {
"description": "True if break prepends the element.",
"type": "boolean"
},
"type": {
"description": "Detected break type.",
"enum": [
"UNKNOWN",
"SPACE",