Skip to content

Item

Source code in docs_src/capo_personalize_events/types/item.py 
14
15
16
17
18
19
20
class Item(TypedDict, closed=True):
    item_id: "capo_personalize_events.types.string_type.StringType"
    """<p>The ID associated with the item.</p>"""
    properties: NotRequired[
        "capo_personalize_events.types.synthesized_json_item_properties.SynthesizedJsonItemProperties"
    ]
    r"""<p>A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{"numberOfRatings": "12"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the <code>numberOfRatings</code> matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>"""

item_id instance-attribute 

item_id: StringType

The ID associated with the item.

properties instance-attribute 

properties: NotRequired[SynthesizedJsonItemProperties]

A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"}.

The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".