Skip to main content

Gcp/vision

@swamp/gcp/visionv2026.07.21.3· 6d agoMODELS
01README

Google Cloud vision infrastructure models

02Release Notes
  • Updated: productsets, productsets_products, products, products_referenceimages
03Models4
@swamp/gcp/vision/productsv2026.07.21.2products.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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')
fn create()
Create a products
fn get(identifier: string)
Get a products
ArgumentTypeDescription
identifierstringThe name of the products
fn update(identifier?: string)
Update products attributes
ArgumentTypeDescription
identifier?stringTarget a specific products by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the products
ArgumentTypeDescription
identifierstringThe name of the products
fn sync(identifier?: string)
Sync products state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific products by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List products resources
ArgumentTypeDescription
pageSize?numberThe maximum number of items to return. Default 10, maximum 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn purge(deleteOrphanProducts?: any, force?: any, productSetPurgeConfig?: any)
purge
ArgumentTypeDescription
deleteOrphanProducts?any
force?any
productSetPurgeConfig?any

Resources

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

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
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 `/`.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a referenceImages
fn get(identifier: string)
Get a referenceImages
ArgumentTypeDescription
identifierstringThe name of the referenceImages
fn delete(identifier: string)
Delete the referenceImages
ArgumentTypeDescription
identifierstringThe name of the referenceImages
fn sync(identifier?: string)
Sync referenceImages state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific referenceImages by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List referenceImages resources
ArgumentTypeDescription
pageSize?numberThe maximum number of items to return. Default 10, maximum 100.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

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

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
displayName?stringThe user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.
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')
fn create()
Create a productSets
fn get(identifier: string)
Get a productSets
ArgumentTypeDescription
identifierstringThe name of the productSets
fn update(identifier?: string)
Update productSets attributes
ArgumentTypeDescription
identifier?stringTarget a specific productSets by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the productSets
ArgumentTypeDescription
identifierstringThe name of the productSets
fn sync(identifier?: string)
Sync productSets state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific productSets by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List productSets resources
ArgumentTypeDescription
pageSize?numberThe maximum number of items to return. Default 10, maximum 100.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn add_product(product?: any)
add product
ArgumentTypeDescription
product?any
fn import(inputConfig?: any)
import
ArgumentTypeDescription
inputConfig?any

Resources

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

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
namestringRequired. The ProductSet resource for which to retrieve Products. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
fn get(identifier: string)
Get a products
ArgumentTypeDescription
identifierstringThe name of the products
fn sync(identifier?: string)
Sync products state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific products by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List products resources
ArgumentTypeDescription
pageSize?numberThe maximum number of items to return. Default 10, maximum 100.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A Product contains ReferenceImages.
04Previous Versions19
2026.07.21.1
  • Updated: productsets
2026.07.20.1
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.07.19.2
  • Updated: productsets_products
2026.07.19.1
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.07.18.2
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.07.17.2
  • Updated: productsets, products, products_referenceimages
2026.07.17.1
  • Updated: productsets, products, products_referenceimages

Added 4, removed 1 models

2026.06.08.2
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.06.07.1
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.05.25.1
  • Updated: productsets, productsets_products, products, products_referenceimages

Modified 4 models

2026.05.24.1
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.05.21.2
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.05.18.1
2026.04.23.1
2026.04.03.3
  • Updated: productsets, productsets_products, products, products_referenceimages
2026.04.03.1
  • Updated: productsets, productsets_products, products, products_referenceimages
05Stats
A
100 / 100
Downloads
0
Archive size
50.8 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels