Method: projects.locations.products.referenceImages.delete

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Possible errors:

  • Returns NOT_FOUND if the reference image does not exist.

HTTP request

DELETE https://vision.googleapis.com/v1p3beta1/{name=projects/*/locations/*/products/*/referenceImages/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The resource name of the reference image to delete.

Format is:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

For more information, see the Authentication Overview.