Struct gapi_grpc::google::cloud::recommendationengine::v1beta1::CatalogItem

pub struct CatalogItem {
    pub id: String,
    pub category_hierarchies: Vec<CategoryHierarchy>,
    pub title: String,
    pub description: String,
    pub item_attributes: Option<FeatureMap>,
    pub language_code: String,
    pub tags: Vec<String>,
    pub item_group_id: String,
    pub recommendation_type: Option<RecommendationType>,
}

CatalogItem captures all metadata information of items to be recommended.

Fields

id: String

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.

category_hierarchies: Vec<CategoryHierarchy>

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"] }
 ]

title: String

Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

description: String

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

item_attributes: Option<FeatureMap>

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.

language_code: String

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.

tags: Vec<String>

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.

item_group_id: String

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.

recommendation_type: Option<RecommendationType>

Extra catalog item metadata for different recommendation types.

Trait Implementations

impl Clone for CatalogItem

fn clone(&self) -> CatalogItem

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogItem

fn default() -> CatalogItem

Returns the “default value” for a type.

impl Message for CatalogItem

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<CatalogItem> for CatalogItem

fn eq(&self, other: &CatalogItem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CatalogItem) -> bool

This method tests for !=.

impl StructuralPartialEq for CatalogItem