public sealed class CatalogItem : IMessage<CatalogItem>, IEquatable<CatalogItem>, IDeepCloneable<CatalogItem>, IBufferMessage, IMessageReference documentation and code samples for the Recommendations AI v1beta1 API class CatalogItem.
CatalogItem captures all metadata information of items to be recommended.
Implements
IMessageCatalogItem, IEquatableCatalogItem, IDeepCloneableCatalogItem, IBufferMessage, IMessageNamespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Constructors
CatalogItem()
public CatalogItem()CatalogItem(CatalogItem)
public CatalogItem(CatalogItem other)| Parameter | |
|---|---|
| Name | Description |
other | CatalogItem |
Properties
CategoryHierarchies
public RepeatedField<CatalogItem.Types.CategoryHierarchy> CategoryHierarchies { get; }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"] }
]
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldCatalogItemTypesCategoryHierarchy | |
Description
public string Description { get; set; }Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.
| Property Value | |
|---|---|
| Type | Description |
string | |
Id
public string Id { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
ItemAttributes
public FeatureMap ItemAttributes { get; set; }Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here.
| Property Value | |
|---|---|
| Type | Description |
FeatureMap | |
ItemGroupId
public string ItemGroupId { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
LanguageCode
public string LanguageCode { get; set; }Optional. Language of the title/description/item_attributes. Use language tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh', 'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact your Google account manager.
| Property Value | |
|---|---|
| Type | Description |
string | |
ProductMetadata
public ProductCatalogItem ProductMetadata { get; set; }Optional. Metadata specific to retail products.
| Property Value | |
|---|---|
| Type | Description |
ProductCatalogItem | |
RecommendationTypeCase
public CatalogItem.RecommendationTypeOneofCase RecommendationTypeCase { get; }| Property Value | |
|---|---|
| Type | Description |
CatalogItemRecommendationTypeOneofCase | |
Tags
public RepeatedField<string> Tags { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring | |
Title
public string Title { get; set; }Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.
| Property Value | |
|---|---|
| Type | Description |
string | |