Skip to main content

@swamp/gcp/vision

v2026.04.23.1

Google Cloud vision infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudvisioncloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/vision

@swamp/gcp/vision/productsv2026.04.23.1products.ts

Global Arguments

ArgumentTypeDescription
description?stringUser-provided metadata to be stored with this product. Must be at most 4096 characters long.
displayName?stringThe user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
name?stringThe 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?stringImmutable. 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?arrayKey-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, othe
productId?stringA user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a products
getGet a products
ArgumentTypeDescription
identifierstringThe name of the products
updateUpdate products attributes
deleteDelete the products
ArgumentTypeDescription
identifierstringThe name of the products
syncSync products state from GCP
purgepurge
ArgumentTypeDescription
deleteOrphanProducts?any
force?any
productSetPurgeConfig?any

Resources

state(infinite)— A Product contains ReferenceImages.
@swamp/gcp/vision/products-referenceimagesv2026.04.23.1products_referenceimages.ts

Global Arguments

ArgumentTypeDescription
boundingPolys?arrayOptional. 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?stringThe 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?stringRequired. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`.
referenceImageId?stringA user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a referenceImages
getGet a referenceImages
ArgumentTypeDescription
identifierstringThe name of the referenceImages
deleteDelete the referenceImages
ArgumentTypeDescription
identifierstringThe name of the referenceImages
syncSync referenceImages state from GCP

Resources

state(infinite)— A `ReferenceImage` represents a product image and its associated metadata, su...
@swamp/gcp/vision/productsetsv2026.04.23.1productsets.ts

Global Arguments

ArgumentTypeDescription
displayName?stringThe user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
indexError?objectThe `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).
name?stringThe 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.
productSetId?stringA user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a productSets
getGet a productSets
ArgumentTypeDescription
identifierstringThe name of the productSets
updateUpdate productSets attributes
deleteDelete the productSets
ArgumentTypeDescription
identifierstringThe name of the productSets
syncSync productSets state from GCP
add_productadd product
ArgumentTypeDescription
product?any
importimport
ArgumentTypeDescription
inputConfig?any

Resources

state(infinite)— A ProductSet contains Products. A ProductSet can contain a maximum of 1 milli...
@swamp/gcp/vision/productsets-productsv2026.04.23.1productsets_products.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a products
ArgumentTypeDescription
identifierstringThe name of the products
syncSync products state from GCP

Resources

state(infinite)— A Product contains ReferenceImages.