> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # google-cloud-vision > Google Cloud Vision **Server path:** `/google-cloud-vision` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`google_cloud_vision_operations_cancel`](#google_cloud_vision_operations_cancel) | 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`. | | [`google_cloud_vision_projects_locations_files_annotate`](#google_cloud_vision_projects_locations_files_annotate) | 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. | | [`google_cloud_vision_projects_locations_files_async_batch_annotate`](#google_cloud_vision_projects_locations_files_async_batch_annotate) | 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). | | [`google_cloud_vision_projects_locations_images_annotate`](#google_cloud_vision_projects_locations_images_annotate) | Run image detection and annotation for a batch of images. | | [`google_cloud_vision_projects_locations_images_async_batch_annotate`](#google_cloud_vision_projects_locations_images_async_batch_annotate) | 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. | | [`google_cloud_vision_projects_locations_product_sets_add_product`](#google_cloud_vision_projects_locations_product_sets_add_product) | 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. | | [`google_cloud_vision_projects_locations_product_sets_create`](#google_cloud_vision_projects_locations_product_sets_create) | Creates and returns a new ProductSet resource. Possible errors: \* Returns INVALID\_ARGUMENT if display\_name is missing, or is longer than 4096 characters. | | [`google_cloud_vision_projects_locations_product_sets_delete`](#google_cloud_vision_projects_locations_product_sets_delete) | Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. | | [`google_cloud_vision_projects_locations_product_sets_import`](#google_cloud_vision_projects_locations_product_sets_import) | 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. | | [`google_cloud_vision_projects_locations_product_sets_list`](#google_cloud_vision_projects_locations_product_sets_list) | Lists ProductSets in an unspecified order. Possible errors: \* Returns INVALID\_ARGUMENT if page\_size is greater than 100, or less than 1. | | [`google_cloud_vision_projects_locations_product_sets_patch`](#google_cloud_vision_projects_locations_product_sets_patch) | 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. | | [`google_cloud_vision_projects_locations_product_sets_products_list`](#google_cloud_vision_projects_locations_product_sets_products_list) | 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. | | [`google_cloud_vision_projects_locations_product_sets_remove_product`](#google_cloud_vision_projects_locations_product_sets_remove_product) | Removes a Product from the specified ProductSet. | | [`google_cloud_vision_projects_locations_products_create`](#google_cloud_vision_projects_locations_products_create) | 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. | | [`google_cloud_vision_projects_locations_products_list`](#google_cloud_vision_projects_locations_products_list) | Lists products in an unspecified order. Possible errors: \* Returns INVALID\_ARGUMENT if page\_size is greater than 100 or less than 1. | | [`google_cloud_vision_projects_locations_products_purge`](#google_cloud_vision_projects_locations_products_purge) | 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) | | [`google_cloud_vision_projects_locations_products_reference_images_create`](#google_cloud_vision_projects_locations_products_reference_images_create) | 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. | | [`google_cloud_vision_projects_locations_products_reference_images_list`](#google_cloud_vision_projects_locations_products_reference_images_list) | 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. | | [`google_cloud_vision_projects_operations_get`](#google_cloud_vision_projects_operations_get) | 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. | *** ## google\_cloud\_vision\_operations\_cancel 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`. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | The name of the operation resource to be cancelled. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "The name of the operation resource to be cancelled." } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_files\_annotate Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported. This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. | | `labels` | object | No | — | Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. | | `requests` | object\[] | No | — | Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`." }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "maxResults": { "type": "integer", "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`." }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/weekly\" for the bleeding edge release updated weekly." }, "type": { "type": "string", "description": "The feature type." } } }, "description": "Required. Requested features." }, "imageContext": { "type": "object", "description": "Image context and/or feature-specific parameters." }, "inputConfig": { "type": "object", "description": "The desired input location and metadata." }, "pages": { "type": "array", "items": { "type": "integer" }, "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." } } }, "description": "Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_files\_async\_batch\_annotate Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `OperationMetadata` (metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. | | `labels` | object | No | — | Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. | | `requests` | object\[] | No | — | Required. Individual async file annotation requests for this batch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`." }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "maxResults": { "type": "integer", "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`." }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/weekly\" for the bleeding edge release updated weekly." }, "type": { "type": "string", "description": "The feature type." } } }, "description": "Required. Requested features." }, "imageContext": { "type": "object", "description": "Image context and/or feature-specific parameters." }, "inputConfig": { "type": "object", "description": "The desired input location and metadata." }, "outputConfig": { "type": "object", "description": "The desired output location and metadata." } } }, "description": "Required. Individual async file annotation requests for this batch." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_images\_annotate Run image detection and annotation for a batch of images. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. | | `labels` | object | No | — | Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. | | `requests` | object\[] | No | — | Required. Individual image annotation requests for this batch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`." }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "requests": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "maxResults": { "type": "integer", "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`." }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/weekly\" for the bleeding edge release updated weekly." }, "type": { "type": "string", "description": "The feature type." } } }, "description": "Requested features." }, "image": { "type": "object", "description": "Client image to perform Google Cloud Vision API tasks over." }, "imageContext": { "type": "object", "description": "Image context and/or feature-specific parameters." } } }, "description": "Required. Individual image annotation requests for this batch." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_images\_async\_batch\_annotate 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`. | | `labels` | object | No | — | Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. | | `outputConfig` | object | No | — | The desired output location and metadata. | | `requests` | object\[] | No | — | Required. Individual image annotation requests for this batch. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Optional. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no parent is specified, a region will be chosen automatically. Supported location-ids: `us`: USA country only, `asia`: East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: `projects/project-A/locations/eu`." }, "labels": { "type": "object", "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter." }, "outputConfig": { "type": "object", "description": "The desired output location and metadata.", "properties": { "batchSize": { "type": "integer", "description": "The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If `batch_size` = 20, then 5 json files each containing 20 response protos will be written under the prefix `gcs_destination`.`uri`. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations." }, "gcsDestination": { "type": "object", "description": "The Google Cloud Storage location where the output will be written to." } } }, "requests": { "type": "array", "items": { "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "maxResults": { "type": "integer", "description": "Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`." }, "model": { "type": "string", "description": "Model to use for the feature. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\". `DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` also support \"builtin/weekly\" for the bleeding edge release updated weekly." }, "type": { "type": "string", "description": "The feature type." } } }, "description": "Requested features." }, "image": { "type": "object", "description": "Client image to perform Google Cloud Vision API tasks over." }, "imageContext": { "type": "object", "description": "Image context and/or feature-specific parameters." } } }, "description": "Required. Individual image annotation requests for this batch." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_add\_product 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` | | `product` | string | No | — | Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`" }, "product": { "type": "string", "description": "Required. The resource name for the Product to be added to this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`" } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_create Creates and returns a new ProductSet resource. Possible errors: \* Returns INVALID\_ARGUMENT if display\_name is missing, or is longer than 4096 characters. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. | | `productSetId` | string | No | — | 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 `/`. | | `displayName` | string | No | — | The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. | | `indexError` | object | No | — | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | | `indexTime` | string | No | — | Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. | | `name` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project in which the ProductSet should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`." }, "productSetId": { "type": "string", "description": "A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`." }, "displayName": { "type": "string", "description": "The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long." }, "indexError": { "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "type": "array", "items": { "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } } }, "indexTime": { "type": "string", "description": "Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value \"1970-01-01T00:00:00Z\". This field is ignored when creating a ProductSet." }, "name": { "type": "string", "description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_delete Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "Required. Resource name of the ProductSet to delete. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`" } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_import 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`. | | `inputConfig` | object | No | — | The input content for the `ImportProductSets` method. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project in which the ProductSets should be imported. Format is `projects/PROJECT_ID/locations/LOC_ID`." }, "inputConfig": { "type": "object", "description": "The input content for the `ImportProductSets` method.", "properties": { "gcsSource": { "type": "object", "description": "The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line." } } } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_list Lists ProductSets in an unspecified order. Possible errors: \* Returns INVALID\_ARGUMENT if page\_size is greater than 100, or less than 1. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`. | | `pageSize` | integer | No | — | The maximum number of items to return. Default 10, maximum 100. | | `pageToken` | string | No | — | The next\_page\_token returned from a previous List request, if any. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project from which ProductSets should be listed. Format is `projects/PROJECT_ID/locations/LOC_ID`." }, "pageSize": { "type": "integer", "description": "The maximum number of items to return. Default 10, maximum 100." }, "pageToken": { "type": "string", "description": "The next_page_token returned from a previous List request, if any." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_patch 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | 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. | | `updateMask` | string | No | — | 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`. | | `displayName` | string | No | — | The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. | | `indexError` | object | No | — | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). | | `indexTime` | string | No | — | Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet." }, "updateMask": { "type": "string", "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`." }, "displayName": { "type": "string", "description": "The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long." }, "indexError": { "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "type": "array", "items": { "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } } }, "indexTime": { "type": "string", "description": "Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value \"1970-01-01T00:00:00Z\". This field is ignored when creating a ProductSet." } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_products\_list 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` | | `pageSize` | integer | No | — | The maximum number of items to return. Default 10, maximum 100. | | `pageToken` | string | No | — | The next\_page\_token returned from a previous List request, if any. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "Required. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`" }, "pageSize": { "type": "integer", "description": "The maximum number of items to return. Default 10, maximum 100." }, "pageToken": { "type": "string", "description": "The next_page_token returned from a previous List request, if any." } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_product\_sets\_remove\_product Removes a Product from the specified ProductSet. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` | | `product` | string | No | — | Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "Required. The resource name for the ProductSet to modify. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`" }, "product": { "type": "string", "description": "Required. The resource name for the Product to be removed from this ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`" } }, "required": [ "PCID", "name" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_products\_create 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`. | | `productId` | string | No | — | 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 `/`. | | `description` | string | No | — | User-provided metadata to be stored with this product. Must be at most 4096 characters long. | | `displayName` | string | No | — | The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. | | `name` | string | No | — | The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. | | `productCategory` | string | No | — | Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. | | `productLabels` | object\[] | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project in which the Product should be created. Format is `projects/PROJECT_ID/locations/LOC_ID`." }, "productId": { "type": "string", "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 `/`." }, "description": { "type": "string", "description": "User-provided metadata to be stored with this product. Must be at most 4096 characters long." }, "displayName": { "type": "string", "description": "The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long." }, "name": { "type": "string", "description": "The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product." }, "productCategory": { "type": "string", "description": "Immutable. The category for the product identified by the reference image. This should be one of \"homegoods-v2\", \"apparel-v2\", \"toys-v2\", \"packagedgoods-v1\" or \"general-v1\". The legacy categories \"homegoods\", \"apparel\", and \"toys\" are still supported, but these should not be used for new products." }, "productLabels": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." }, "value": { "type": "string", "description": "The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes." } } }, "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." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_products\_list Lists products in an unspecified order. Possible errors: \* Returns INVALID\_ARGUMENT if page\_size is greater than 100 or less than 1. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID` | | `pageSize` | integer | No | — | The maximum number of items to return. Default 10, maximum 100. | | `pageToken` | string | No | — | The next\_page\_token returned from a previous List request, if any. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project OR ProductSet from which Products should be listed. Format: `projects/PROJECT_ID/locations/LOC_ID`" }, "pageSize": { "type": "integer", "description": "The maximum number of items to return. Default 10, maximum 100." }, "pageToken": { "type": "string", "description": "The next_page_token returned from a previous List request, if any." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_products\_purge 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) **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`. | | `deleteOrphanProducts` | boolean | No | — | If delete\_orphan\_products is true, all Products that are not in any ProductSet will be deleted. | | `force` | boolean | No | — | The default value is false. Override this value to true to actually perform the purge. | | `productSetPurgeConfig` | object | No | — | Config to control which ProductSet contains the Products to be deleted. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. The project and location in which the Products should be deleted. Format is `projects/PROJECT_ID/locations/LOC_ID`." }, "deleteOrphanProducts": { "type": "boolean", "description": "If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted." }, "force": { "type": "boolean", "description": "The default value is false. Override this value to true to actually perform the purge." }, "productSetPurgeConfig": { "type": "object", "description": "Config to control which ProductSet contains the Products to be deleted.", "properties": { "productSetId": { "type": "string", "description": "The ProductSet that contains the Products to delete. If a Product is a member of product_set_id in addition to other ProductSets, the Product will still be deleted." } } } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_products\_reference\_images\_create 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. Resource name of the product in which to create the reference image. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. | | `referenceImageId` | string | No | — | 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 `/`. | | `boundingPolys` | object\[] | No | — | Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). | | `name` | string | No | — | The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. | | `uri` | string | No | — | Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "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`." }, "referenceImageId": { "type": "string", "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 `/`." }, "boundingPolys": { "type": "array", "items": { "type": "object", "properties": { "normalizedVertices": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "number", "description": "X coordinate." }, "y": { "type": "number", "description": "Y coordinate." } } }, "description": "The bounding polygon normalized vertices." }, "vertices": { "type": "array", "items": { "type": "object", "properties": { "x": { "type": "integer", "description": "X coordinate." }, "y": { "type": "integer", "description": "Y coordinate." } } }, "description": "The bounding polygon vertices." } } }, "description": "Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not)." }, "name": { "type": "string", "description": "The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image." }, "uri": { "type": "string", "description": "Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_locations\_products\_reference\_images\_list 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. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `parent` | string | Yes | — | Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. | | `pageSize` | integer | No | — | The maximum number of items to return. Default 10, maximum 100. | | `pageToken` | string | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "parent": { "type": "string", "description": "Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`." }, "pageSize": { "type": "integer", "description": "The maximum number of items to return. Default 10, maximum 100." }, "pageToken": { "type": "string", "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." } }, "required": [ "PCID", "parent" ] } ``` *** ## google\_cloud\_vision\_projects\_operations\_get Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `$.xgafv` | string | No | — | V1 error format. | | `access_token` | string | No | — | OAuth access token. | | `alt` | string | No | — | Data format for response. | | `callback` | string | No | — | JSONP | | `fields` | string | No | — | Selector specifying which fields to include in a partial response. | | `key` | string | No | — | 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. | | `oauth_token` | string | No | — | OAuth 2.0 token for the current user. | | `prettyPrint` | boolean | No | — | Returns response with indentations and line breaks. | | `quotaUser` | string | No | — | 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. | | `upload_protocol` | string | No | — | Upload protocol for media (e.g. "raw", "multipart"). | | `uploadType` | string | No | — | Legacy upload protocol for media (e.g. "media", "multipart"). | | `name` | string | Yes | — | The name of the operation resource. | | `filter` | string | No | — | The standard list filter. | | `pageSize` | integer | No | — | The standard list page size. | | `pageToken` | string | No | — | The standard list page token. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "access_token": { "type": "string", "description": "OAuth access token." }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "callback": { "type": "string", "description": "JSONP" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "type": "string", "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." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks." }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "name": { "type": "string", "description": "The name of the operation resource." }, "filter": { "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "description": "The standard list page size." }, "pageToken": { "type": "string", "description": "The standard list page token." } }, "required": [ "PCID", "name" ] } ```