google_api_vision v0.21.0 GoogleApi.Vision.V1.Model.GoogleCloudVisionV1p1beta1Product View Source

A Product contains ReferenceImages.

Attributes

  • description (type: String.t, default: nil) - User-provided metadata to be stored with this product. Must be at most 4096 characters long.

  • displayName (type: String.t, default: nil) - The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

  • name (type: String.t, default: nil) - 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.t, default: nil) - Immutable. The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

  • productLabels (type: list(GoogleApi.Vision.V1.Model.GoogleCloudVisionV1p1beta1ProductKeyValue.t), default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Vision.V1.Model.GoogleCloudVisionV1p1beta1Product{
  description: String.t(),
  displayName: String.t(),
  name: String.t(),
  productCategory: String.t(),
  productLabels: [
    GoogleApi.Vision.V1.Model.GoogleCloudVisionV1p1beta1ProductKeyValue.t()
  ]
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.