class Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem

CatalogItem captures all metadata information of items to be recommended.

Attributes

category_hierarchies[RW]

Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [“Shoes & Accessories” -> “Shoes”] and [“ Sports & Fitness” -> “Athletic Clothing” -> “Shoes”], it could be represented as: “categoryHierarchies”: [ ` “categories”: [“Shoes & Accessories”, “Shoes”]`, ` “categories”: [“Sports & Fitness”, “Athletic Clothing”, “Shoes”] ` ] Corresponds to the JSON property `categoryHierarchies` @return [Array<Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy>]

description[RW]

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. Corresponds to the JSON property `description` @return [String]

id[RW]

Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. Corresponds to the JSON property `id` @return [String]

item_attributes[RW]

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features. Corresponds to the JSON property `itemAttributes` @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1FeatureMap]

item_group_id[RW]

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). Corresponds to the JSON property `itemGroupId` @return [String]

language_code[RW]

Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. Corresponds to the JSON property `languageCode` @return [String]

product_metadata[RW]

ProductCatalogItem captures item metadata specific to retail products. Corresponds to the JSON property `productMetadata` @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ProductCatalogItem]

tags[RW]

Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. Corresponds to the JSON property `tags` @return [Array<String>]

title[RW]

Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. Corresponds to the JSON property `title` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 319
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 324
def update!(**args)
  @category_hierarchies = args[:category_hierarchies] if args.key?(:category_hierarchies)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @item_attributes = args[:item_attributes] if args.key?(:item_attributes)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @language_code = args[:language_code] if args.key?(:language_code)
  @product_metadata = args[:product_metadata] if args.key?(:product_metadata)
  @tags = args[:tags] if args.key?(:tags)
  @title = args[:title] if args.key?(:title)
end