Gcp/vision
@swamp/gcp/visionv2026.05.25.1
01README
Google Cloud vision infrastructure models
02Release Notes
- Updated: productsets, productsets_products, products, products_referenceimages
03Models
@swamp/gcp/vision/productsv2026.05.25.1products.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| description? | string | User-provided metadata to be stored with this product. Must be at most 4096 characters long. |
| displayName? | string | The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. |
| name? | string | 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 | 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? | array | 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, othe |
| productId? | string | A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a products
fn get(identifier: string)
Get a products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
fn update()
Update products attributes
fn delete(identifier: string)
Delete the products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
fn sync()
Sync products state from GCP
fn list(pageSize?: number, maxPages?: number)
List products resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. Default 10, maximum 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn purge(deleteOrphanProducts?: any, force?: any, productSetPurgeConfig?: any)
purge
| Argument | Type | Description |
|---|---|---|
| deleteOrphanProducts? | any | |
| force? | any | |
| productSetPurgeConfig? | any |
Resources
state(infinite)— A Product contains ReferenceImages.
@swamp/gcp/vision/products-referenceimagesv2026.05.25.1products_referenceimages.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| boundingPolys? | array | 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 | 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 | Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. |
| referenceImageId? | string | A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a referenceImages
fn get(identifier: string)
Get a referenceImages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the referenceImages |
fn delete(identifier: string)
Delete the referenceImages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the referenceImages |
fn sync()
Sync referenceImages state from GCP
fn list(pageSize?: number, maxPages?: number)
List referenceImages resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. Default 10, maximum 100. |
| maxPages? | number | Maximum 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.05.25.1productsets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. |
| indexError? | object | 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). |
| name? | string | 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. |
| productSetId? | string | A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a productSets
fn get(identifier: string)
Get a productSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the productSets |
fn update()
Update productSets attributes
fn delete(identifier: string)
Delete the productSets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the productSets |
fn sync()
Sync productSets state from GCP
fn list(pageSize?: number, maxPages?: number)
List productSets resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. Default 10, maximum 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_product(product?: any)
add product
| Argument | Type | Description |
|---|---|---|
| product? | any |
fn import(inputConfig?: any)
import
| Argument | Type | Description |
|---|---|---|
| inputConfig? | any |
Resources
state(infinite)— A ProductSet contains Products. A ProductSet can contain a maximum of 1 milli...
@swamp/gcp/vision/productsets-productsv2026.05.25.1productsets_products.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
fn sync()
Sync products state from GCP
fn list(pageSize?: number, maxPages?: number)
List products resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of items to return. Default 10, maximum 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A Product contains ReferenceImages.
04Previous Versions
2026.05.24.1May 24, 2026
- Updated: productsets, productsets_products, products, products_referenceimages
2026.05.21.2May 21, 2026
- Updated: productsets, productsets_products, products, products_referenceimages
2026.05.21.1May 21, 2026
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.1May 18, 2026
2026.04.23.1Apr 23, 2026
2026.04.03.3Apr 3, 2026
- Updated: productsets, productsets_products, products, products_referenceimages
2026.04.03.1Apr 3, 2026
- Updated: productsets, productsets_products, products, products_referenceimages
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: productsets, productsets_products, products, products_referenceimages
05Stats
A
100 / 100
Downloads
0
Archive size
39.4 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 types1/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